From 4281d3043eb6993f5ac6dea816422fc44e137146 Mon Sep 17 00:00:00 2001 From: Orq GitHub Actions Date: Wed, 18 Dec 2024 09:53:07 +0000 Subject: [PATCH] Publish openapi schema --- openapi-prerelease.yaml | 76474 +++++++++++++++++++++++++- openapi.yaml | 76474 +++++++++++++++++++++++++- packages/orq-rc/.speakeasy/gen.yaml | 2 +- 3 files changed, 149151 insertions(+), 3799 deletions(-) diff --git a/openapi-prerelease.yaml b/openapi-prerelease.yaml index 406cc2c..8933341 100644 --- a/openapi-prerelease.yaml +++ b/openapi-prerelease.yaml @@ -1153,7 +1153,6 @@ components: - "chat" - "completion" - "image" - - "vision" description: "Indicates the type of model used to generate the response" "model": type: "string" @@ -2878,7 +2877,7 @@ components: "created": type: "string" format: "date-time" - default: "2024-12-16T16:28:54.131Z" + default: "2024-12-01T21:30:45.101Z" description: "The date and time the resource was created" readOnly: true required: @@ -2922,7 +2921,7 @@ components: "created": type: "string" format: "date-time" - default: "2024-12-16T16:28:54.131Z" + default: "2024-12-01T21:30:45.101Z" description: "The date and time the resource was created" readOnly: true required: @@ -2948,72 +2947,416 @@ components: required: - "files" - "purpose" - "GetRemoteConfigRequest": + "DatasetCreateRequest": type: "object" properties: - "key": + "display_name": type: "string" - description: "Remote configuration key" - "context": - type: "object" - additionalProperties: {} - description: "Key-value pairs matching your data model, applied to each prompt key." - "metadata": - type: "object" - additionalProperties: {} - description: "Key-value pairs to attach to the log generated by this request." + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" required: - - "key" - "GetRemoteConfigResponse": + - "display_name" + - "domain_id" + "DatasetDeleteRequest": type: "object" properties: - "type": + "dataset_id": type: "string" - enum: - - "boolean" - - "string" - - "integer" - - "decimal" - - "list" - - "json" - - "deployment" - "value": {} + description: "Dataset ID" required: - - "type" - "HonoApiError": + - "dataset_id" + "DatasetGetOneRequest": type: "object" properties: - "code": + "dataset_id": type: "string" - description: "HTTP status code" - "message": + description: "Dataset ID" + required: + - "dataset_id" + "DatasetUpdateRequest": + type: "object" + properties: + "display_name": type: "string" - description: "Error message" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + "DatasetCreateResponse": + type: "object" + properties: + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" required: - - "message" - "Deployments": + - "display_name" + - "domain_id" + "DatasetGetOneResponse": + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + "updated_by": + type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "email": + type: "string" + format: "email" + description: "Email of the user" + "display_name": + type: "string" + description: "Display name of the user" + "logo_url": + type: + - "string" + - "null" + format: "uri" + description: "URL of the user logo" + required: + - "id" + - "email" + - "display_name" + - "logo_url" + description: "User model returned from the API" + "updated_by_id": + type: + - "string" + - "null" + format: "uuid" + description: "The user who last updated the dataset" + "items": + type: "array" + items: + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset row model from the API." + required: + - "id" + - "display_name" + - "domain_id" + - "updated_by" + - "updated_by_id" + - "items" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset model from the API" + "DatasetUpdateResponse": type: "object" properties: - "key": + "display_name": type: "string" - description: "The deployment id to invoke" - "stream": - type: "boolean" - default: false - description: "If set, partial message content will be sent. Tokens will be sent as data-only `server-sent events` as they become available, with the stream terminated by a `data: [DONE]` message." - "inputs": - type: "object" - additionalProperties: - anyOf: - - type: "string" - - type: "number" - - type: "boolean" - description: "Key-value pairs variables to replace in your prompts. If a variable is not provided that is defined in the prompt, the default variables are used." - "context": - type: "object" - additionalProperties: {} - description: "Key-value pairs that match your data model and fields declared in your configuration matrix. If you send multiple prompt keys, the context will be applied to the evaluation of each key." - "prefix_messages": + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + "DatasetRowPostBulkRequest": + type: "object" + properties: + "datasetRows": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + description: "Expected dataset row model when talking to the API." + example: {"id": "uuid-string", "messages": [{"role": "assistant", "content": "You are a helpful assistant.", "tool_calls": [{"id": "tool-id", "index": 0, "type": "function", "function": {"name": "some-function", "arguments": "some-args"}}]}]} + required: + - "datasetRows" + "DatasetRowPostRequest": + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "messages": type: "array" items: type: "object" @@ -3111,7 +3454,39 @@ components: required: - "role" - "content" - description: "A list of messages to include after the `System` message, but before the `User` and `Assistant` pairs configured in your deployment." + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + "DatasetIdParamRequest": + type: "object" + properties: + "dataset_id": + type: "string" + description: "Dataset ID" + required: + - "dataset_id" + "DatasetRowIdParamRequest": + type: "object" + properties: + "row_id": + type: "string" + description: "Dataset row ID" + required: + - "row_id" + "DatasetRowPostResponse": + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true "messages": type: "array" items: @@ -3210,556 +3585,998 @@ components: required: - "role" - "content" - description: "A list of messages to send to the deployment." - "file_ids": - type: "array" - items: - type: "string" - description: "A list of file IDs that are associated with the deployment request." - "metadata": - type: "object" - additionalProperties: {} - description: "Key-value pairs that you want to attach to the log generated by this request." - "chain_id": - type: "string" - description: "Unique ID that identifies a chaining operation. This is useful for tracking a chain of completions across multiple " - "conversation_id": - type: "string" - description: "Unique ID that identifies a chat conversation. This is useful for tracking the same conversation across multiple requests" - "user_id": - anyOf: - - type: "string" - - type: "number" - description: "Unique ID that identifies a user. This is useful for tracking the same user across multiple requests" - "deployment_id": - type: "string" - description: "Unique ID that identifies a deployment entity." - "deployment_variant_id": - type: "string" - description: "Unique ID that identifies a specific variant of a deployment." - "extra_params": - type: "object" - additionalProperties: {} - description: "Utilized for passing additional parameters to the model provider. Exercise caution when using this feature, as the included parameters will overwrite any parameters specified in the deployment prompt configuration." - "invoke_options": - type: "object" - properties: - "include_retrievals": - type: "boolean" - default: false - description: "Whether to include the retrieved knowledge chunks in the response." + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" required: - - "key" - description: "The deployment request payload" -paths: - "/v2/contacts": - post: - tags: - - "Contacts" - x-speakeasy-name-override: "create" - operationId: "CreateContact" - description: "Update or add user information to workspace" - summary: "Update user information" - requestBody: - required: true - description: "Update user information payload" - content: - "application/json": - schema: - type: "object" - properties: - "external_id": - type: "string" - minLength: 1 - description: "Unique string value to identify the contact user in the customer's system" - "display_name": - type: - - "string" - - "null" - description: "Display name or nickname of the user" - "email": - type: - - "string" - - "null" - format: "email" - description: "Email address of the user" - "avatar_url": - type: - - "string" - - "null" - description: "URL linking to the user's avatar image" - "tags": - type: "array" - items: - type: "string" - format: "uuid" - description: "Array of UUIDs representing tags associated with the user" - "metadata": - type: "object" - additionalProperties: {} - description: "Additional custom metadata associated with the user as key-value pairs" - required: - - "external_id" - responses: - "200": - description: "Successful operation" - content: - "application/json": - schema: - type: "object" - properties: - "id": - type: "string" - description: "Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the user" - "external_id": - type: "string" - minLength: 1 - description: "Unique string value to identify the contact user in the customer's system" - "display_name": - type: - - "string" - - "null" - description: "Display name or nickname of the user" - "email": - type: - - "string" - - "null" - format: "email" - description: "Email address of the user" - "avatar_url": - type: - - "string" - - "null" - description: "URL linking to the user's avatar image" - "tags": - type: "array" - items: - type: "string" - format: "uuid" - description: "Array of UUIDs representing tags associated with the user" - "metadata": - type: "object" - additionalProperties: {} - description: "Additional custom metadata associated with the user as key-value pairs" - "created": - anyOf: - - type: "string" - format: "date-time" - - type: "string" - default: "2024-12-16T16:28:53.855Z" - description: "The date and time the resource was created" - readOnly: true - format: "date-time" - "updated": - anyOf: - - type: "string" - format: "date-time" - default: "2024-12-16T16:28:53.856Z" - - type: "string" - description: "The date and time the resource was last updated" - readOnly: true - format: "date-time" - required: - - "id" - - "external_id" - "/v2/feedback": - post: - tags: - - "Feedback" - x-speakeasy-name-override: "create" - operationId: "CreateFeedback" - description: "Submit feedback for the LLM transaction via the API" - summary: "Submit feedback" - requestBody: - required: true - description: "Feedback submission payload" - content: - "application/json": - schema: - type: "object" - properties: - "property": - type: "string" - description: "A string describing the specific property or aspect rated." - x-speakeasy-name-override: "field" - "value": - anyOf: - - type: "string" - - type: "array" - items: - type: "string" - description: "The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string." - "trace_id": - type: "string" - description: "The id returned by the [`get_config`]() or [`invoke`](https://docs.orq.ai/reference/post_deployments-invoke-1) endpoints" - required: - - "property" - - "value" - - "trace_id" - example: {"value": ["good"], "property": "rating", "trace_id": "67HTZ65Z9W91HSF51CW68KK1QH"} - responses: - "200": - description: "Successful operation" - content: - "application/json": - schema: + - "id" + - "messages" + "DatasetRowGetResponse": + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "messages": + type: "array" + items: type: "object" properties: - "property": + "role": type: "string" - description: "A string describing the specific property or aspect rated." - "value": + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": anyOf: - type: "string" - type: "array" items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": type: "string" - description: "The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string." - "trace_id": - type: "string" - description: "The id returned by the [`get_config`]() or [`invoke`](https://docs.orq.ai/reference/post_deployments-invoke-1) endpoints" - "id": - type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" required: - - "property" - - "value" - - "trace_id" - - "id" - "/v2/deployments": - get: - tags: - - "Deployments" - x-speakeasy-group: "deployments" - x-speakeasy-name-override: "all" - operationId: "Deployments" - description: "Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first." - summary: "List all deployments" - parameters: - - schema: - type: "number" - minimum: 1 - maximum: 50 - default: 10 - description: "A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10" - required: false - description: "A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10" - name: "limit" - in: "query" - - schema: - type: "string" - description: "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `ed33dade-ae32-4959-8c5c-7ae4aad748b5`, your subsequent call can include `after=ed33dade-ae32-4959-8c5c-7ae4aad748b5` in order to fetch the next page of the list." - required: false - description: "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `ed33dade-ae32-4959-8c5c-7ae4aad748b5`, your subsequent call can include `after=ed33dade-ae32-4959-8c5c-7ae4aad748b5` in order to fetch the next page of the list." - name: "after" - in: "query" - responses: - "200": - description: "List of deployments" - content: - "application/json": - schema: - type: "object" + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset row model from the API." + "DatasetRowErrorResponse": + type: "object" + properties: + "message": + type: "string" + required: + - "message" + "DatasetRowPaginatedGetResponse": + type: "object" + properties: + "count": + type: "number" + "page": + type: "number" + "limit": + type: "number" + "totalPages": + type: "number" + "items": + type: "array" + items: + allOf: + - type: "object" properties: - "object": + "id": type: "string" - enum: - - "list" - "data": + format: "uuid" + readOnly: true + "messages": type: "array" items: type: "object" properties: - "id": - type: "string" - format: "uuid" - description: "Unique identifier for the object." - "created": - type: "string" - description: "Date in ISO 8601 format at which the object was created." - "updated": - type: "string" - description: "Date in ISO 8601 format at which the object was last updated." - "key": - type: "string" - description: "The deployment unique key" - "description": + "role": type: "string" - description: "An arbitrary string attached to the object. Often useful for displaying to users." - "prompt_config": - type: "object" - properties: - "tools": - type: "array" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" items: - allOf: + oneOf: - type: "object" properties: "type": type: "string" enum: - - "function" - description: "The type of the tool. Currently, only `function` is supported." - "function": + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": type: "object" properties: - "name": + "id": type: "string" - description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." - "description": + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": type: "string" - description: "A description of what the function does, used by the model to choose when and how to call the function." - "strict": - type: "boolean" - "parameters": - type: "object" - properties: - "type": - type: "string" - enum: - - "object" - "properties": - type: "object" - additionalProperties: {} - "required": - type: "array" - items: - type: "string" - "additionalProperties": - type: "boolean" - enum: - - false - required: - - "type" - - "properties" - description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" required: - - "name" - - "parameters" + - "url" required: - "type" - - "function" - - type: "object" - properties: - "id": - type: "number" - "model": + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset row model from the API." + required: + - "count" + - "page" + - "limit" + - "totalPages" + - "items" + "DatasetRowPatchResponse": + type: "object" + properties: + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": type: "string" - "model_type": + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": type: "string" enum: - - "chat" - - "completion" - - "embedding" - - "vision" - - "image" - - "tts" - - "stt" - - "rerank" - - "moderations" - description: "The type of the model" - "model_parameters": + - "image_url" + "image_url": type: "object" properties: - "temperature": - type: "number" - description: "Only supported on `chat` and `completion` models." - "maxTokens": - type: "number" - description: "Only supported on `chat` and `completion` models." - "topK": - type: "number" - description: "Only supported on `chat` and `completion` models." - "topP": - type: "number" - description: "Only supported on `chat` and `completion` models." - "frequencyPenalty": - type: "number" - description: "Only supported on `chat` and `completion` models." - "presencePenalty": - type: "number" - description: "Only supported on `chat` and `completion` models." - "numImages": - type: "number" - description: "Only supported on `image` models." - "seed": - type: "number" - description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" - "format": - type: "string" - enum: - - "url" - - "b64_json" - - "text" - - "json_object" - description: "Only supported on `image` models." - "dimensions": - type: "string" - description: "Only supported on `image` models." - "quality": - type: "string" - enum: - - "standard" - - "hd" - description: "Only supported on `image` models." - "style": - type: "string" - description: "Only supported on `image` models." - "responseFormat": - oneOf: - - type: "object" - properties: - "type": - type: "string" - enum: - - "json_schema" - "json_schema": - type: "object" - properties: - "name": - type: "string" - "strict": - type: "boolean" - "schema": - type: "object" - additionalProperties: {} - required: - - "name" - - "strict" - - "schema" - required: - - "type" - - "json_schema" - - type: "object" - properties: - "type": - type: "string" - enum: - - "json_object" - required: - - "type" - - type: "null" - description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." - "photoRealVersion": + "id": type: "string" - enum: - - "v1" - - "v2" - description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" - "encoding_format": + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": type: "string" - enum: - - "float" - - "base64" - description: "The format to return the embeddings" - description: "Model Parameters: Not all parameters apply to every model" - "provider": - type: "string" - enum: - - "cohere" - - "openai" - - "anthropic" - - "huggingface" - - "replicate" - - "google" - - "google-ai" - - "azure" - - "aws" - - "anyscale" - - "perplexity" - - "groq" - - "fal" - - "leonardoai" - - "nvidia" - - "jina" - "messages": - type: "array" - items: - type: "object" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "messages" + "PromptTemplateGetAllRequest": + type: "object" + properties: + "page": + type: "string" + "limit": + type: "string" + "PromptTemplateGetAllResponse": + type: "object" + properties: + "count": + type: "number" + "items": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" properties: - "role": + "type": type: "string" enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - anyOf: - - type: "string" - - type: "array" - items: - oneOf: - - type: "object" - properties: - "type": - type: "string" - enum: - - "text" - "text": - type: "string" - required: - - "type" - - "text" - description: "Text content part of a prompt message" - - type: "object" - properties: - "type": - type: "string" - enum: - - "image_url" - "image_url": - type: "object" - properties: - "id": - type: "string" - format: "ulid" - description: "The orq.ai id of the image" - readOnly: true - "url": - anyOf: - - type: "string" - - type: "string" - format: "uri" - description: "Either a URL of the image or the base64 encoded data URI." - examples: - - "https://picsum.photos/id/1/200/300" - - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" - "detail": - type: "string" - description: "Specifies the detail level of the image. Currently only supported with OpenAI models" - required: - - "url" - required: - - "type" - - "image_url" - description: "The image part of the prompt message. Only supported with vision models." - description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " - "tool_calls": - type: "array" - items: - type: "object" + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" properties: - "id": - type: "string" - "index": - type: "number" "type": type: "string" enum: - - "function" - "function": + - "json_schema" + "json_schema": type: "object" properties: "name": type: "string" - "arguments": - type: "string" - description: "JSON string arguments for the functions" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" required: - "name" - "arguments" @@ -3770,1317 +4587,73313 @@ paths: - "role" - "content" required: - - "tools" - - "model" - - "model_type" - - "model_parameters" - - "provider" - "messages" - "version": + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": type: "string" - description: "THe version of the deployment" required: - - "id" - - "created" - - "updated" - - "key" - - "description" + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" - "prompt_config" - - "version" - "has_more": - type: "boolean" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" required: - - "object" - - "data" - - "has_more" - "500": - description: "Internal Server Error" - content: - "application/json": - schema: {"$ref": "#/components/schemas/HonoApiError"} - "/v2/deployments/invalidate/{deployment_id}": - delete: - tags: - - "Deployments" - x-speakeasy-group: "deployments" - x-speakeasy-name-override: "invalidate" - operationId: "InvalidDeployment" - description: "Explicitly invalidate a cache of a deployment" - summary: "Invalidates cache" - security: - - ApiKey: [] - parameters: - - schema: - anyOf: - - type: "string" - format: "uuid" - description: "The id of the resource" - readOnly: true - - type: "string" - format: "ulid" - description: "The id of the resource" - readOnly: true - description: "The deployment id that needs to be invalidated" - required: true - name: "deployment_id" - in: "path" - responses: - "204": - description: "No content - successful operation" - "/v2/deployments/get_config": - post: - tags: - - "Deployments" - x-speakeasy-group: "deployments" - x-speakeasy-name-override: "getConfig" - operationId: "DeploymentGetConfig" - description: "Retrieve the deployment configuration" - summary: "Get config" - requestBody: - required: true - content: - "application/json": - schema: - type: "object" - properties: - "key": - type: "string" - description: "The deployment id to invoke" - "inputs": - type: "object" - additionalProperties: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": anyOf: - type: "string" - - type: "number" - - type: "boolean" - description: "Key-value pairs variables to replace in your prompts. If a variable is not provided that is defined in the prompt, the default variables are used." - "context": - type: "object" - additionalProperties: {} - description: "Key-value pairs that match your data model and fields declared in your configuration matrix. If you send multiple prompt keys, the context will be applied to the evaluation of each key." - "prefix_messages": - type: "array" - items: - type: "object" - properties: - "role": + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": type: "string" enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - anyOf: - - type: "string" - - type: "array" - items: - oneOf: - - type: "object" - properties: - "type": - type: "string" - enum: - - "text" - "text": - type: "string" - required: - - "type" - - "text" - description: "Text content part of a prompt message" - - type: "object" - properties: - "type": - type: "string" - enum: - - "image_url" - "image_url": - type: "object" - properties: - "id": - type: "string" - format: "ulid" - description: "The orq.ai id of the image" - readOnly: true - "url": - anyOf: - - type: "string" - - type: "string" - format: "uri" - description: "Either a URL of the image or the base64 encoded data URI." - examples: - - "https://picsum.photos/id/1/200/300" - - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" - "detail": - type: "string" - description: "Specifies the detail level of the image. Currently only supported with OpenAI models" - required: - - "url" - required: - - "type" - - "image_url" - description: "The image part of the prompt message. Only supported with vision models." - description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " - "tool_calls": + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": type: "array" items: type: "object" properties: - "id": - type: "string" - "index": - type: "number" - "type": + "role": type: "string" enum: - - "function" - "function": - type: "object" - properties: - "name": - type: "string" - "arguments": - type: "string" - description: "JSON string arguments for the functions" - required: - - "name" - - "arguments" + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" required: - - "type" - - "function" + - "role" + - "content" required: - - "role" - - "content" - description: "A list of messages to include after the `System` message, but before the `User` and `Assistant` pairs configured in your deployment." - "messages": - type: "array" - items: + - "messages" + "metadata": type: "object" properties: - "role": + "use_cases": + type: "array" + items: + type: "string" + "language": type: "string" - enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - anyOf: - - type: "string" - - type: "array" - items: - oneOf: - - type: "object" - properties: - "type": - type: "string" - enum: - - "text" - "text": - type: "string" - required: - - "type" - - "text" - description: "Text content part of a prompt message" - - type: "object" - properties: - "type": - type: "string" - enum: - - "image_url" - "image_url": - type: "object" - properties: - "id": - type: "string" - format: "ulid" - description: "The orq.ai id of the image" - readOnly: true - "url": - anyOf: - - type: "string" - - type: "string" - format: "uri" - description: "Either a URL of the image or the base64 encoded data URI." - examples: - - "https://picsum.photos/id/1/200/300" - - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" - "detail": - type: "string" - description: "Specifies the detail level of the image. Currently only supported with OpenAI models" - required: - - "url" - required: - - "type" - - "image_url" - description: "The image part of the prompt message. Only supported with vision models." - description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " - "tool_calls": - type: "array" - items: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": type: "object" properties: - "id": + "stream": + type: "boolean" + "model": type: "string" - "index": - type: "number" - "type": + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": type: "string" enum: - - "function" - "function": + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": type: "object" properties: - "name": + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": type: "string" - "arguments": + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": type: "string" - description: "JSON string arguments for the functions" - required: - - "name" - - "arguments" - required: - - "type" - - "function" - required: - - "role" - - "content" - description: "A list of messages to send to the deployment." - "file_ids": - type: "array" - items: - type: "string" - description: "A list of file IDs that are associated with the deployment request." - "metadata": - type: "object" - additionalProperties: {} - description: "Key-value pairs that you want to attach to the log generated by this request." - "chain_id": - type: "string" - description: "Unique ID that identifies a chaining operation. This is useful for tracking a chain of completions across multiple " - "conversation_id": - type: "string" - description: "Unique ID that identifies a chat conversation. This is useful for tracking the same conversation across multiple requests" - "user_id": - anyOf: - - type: "string" - - type: "number" - description: "Unique ID that identifies a user. This is useful for tracking the same user across multiple requests" - "deployment_id": - type: "string" - description: "Unique ID that identifies a deployment entity." - "deployment_variant_id": - type: "string" - description: "Unique ID that identifies a specific variant of a deployment." - "extra_params": - type: "object" - additionalProperties: {} - description: "Utilized for passing additional parameters to the model provider. Exercise caution when using this feature, as the included parameters will overwrite any parameters specified in the deployment prompt configuration." - "invoke_options": - type: "object" - properties: - "include_retrievals": - type: "boolean" - default: false - description: "Whether to include the retrieved knowledge chunks in the response." - required: - - "key" - responses: - "200": - description: "Configurations Retrieved." - content: - "application/json": - schema: - type: "object" - properties: - "id": - type: "string" - description: "A unique identifier for the response. Can be used to add metrics to the transaction." - "provider": - type: "string" - description: "The provider of the model" - "model": - type: "string" - description: "The model of the configuration" - "type": - type: "string" - enum: - - "chat" - - "completion" - - "embedding" - - "vision" - - "image" - - "tts" - - "stt" - - "rerank" - - "moderations" - description: "The type of the model. Current `chat`,`completion` and `image` are supported" - "version": - type: "string" - description: "The current version of the deployment" - "messages": - type: "array" - items: - type: "object" - properties: - "role": - type: "string" - enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - anyOf: - - type: "string" - - type: "array" - items: - oneOf: - - type: "object" - properties: - "type": - type: "string" - enum: - - "text" - "text": - type: "string" - required: - - "type" - - "text" - description: "Text content part of a prompt message" - - type: "object" - properties: - "type": - type: "string" - enum: - - "image_url" - "image_url": - type: "object" - properties: - "id": - type: "string" - format: "ulid" - description: "The orq.ai id of the image" - readOnly: true - "url": - anyOf: - - type: "string" - - type: "string" - format: "uri" - description: "Either a URL of the image or the base64 encoded data URI." - examples: - - "https://picsum.photos/id/1/200/300" - - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" - "detail": - type: "string" - description: "Specifies the detail level of the image. Currently only supported with OpenAI models" - required: - - "url" - required: - - "type" - - "image_url" - description: "The image part of the prompt message. Only supported with vision models." - description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " - "tool_calls": - type: "array" - items: - type: "object" - properties: - "id": - type: "string" - "index": - type: "number" - "type": - type: "string" - enum: - - "function" - "function": + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: type: "object" properties: - "name": - type: "string" - "arguments": + "role": type: "string" - description: "JSON string arguments for the functions" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" required: - - "name" - - "arguments" - required: - - "type" - - "function" + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" required: - - "role" - - "content" - "parameters": + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": type: "object" properties: - "temperature": - type: "number" - description: "Only supported on `chat` and `completion` models." - "maxTokens": - type: "number" - description: "Only supported on `chat` and `completion` models." - "topK": - type: "number" - description: "Only supported on `chat` and `completion` models." - "topP": - type: "number" - description: "Only supported on `chat` and `completion` models." - "frequencyPenalty": - type: "number" - description: "Only supported on `chat` and `completion` models." - "presencePenalty": - type: "number" - description: "Only supported on `chat` and `completion` models." - "numImages": - type: "number" - description: "Only supported on `image` models." - "seed": - type: "number" - description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" - "format": + "stream": + type: "boolean" + "model": type: "string" - enum: - - "url" - - "b64_json" - - "text" - - "json_object" - description: "Only supported on `image` models." - "dimensions": + "model_db_id": type: "string" - description: "Only supported on `image` models." - "quality": + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": type: "string" enum: - - "standard" - - "hd" - description: "Only supported on `image` models." - "style": - type: "string" - description: "Only supported on `image` models." - "responseFormat": - oneOf: - - type: "object" - properties: - "type": - type: "string" - enum: - - "json_schema" - "json_schema": - type: "object" + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" properties: - "name": + "type": type: "string" - "strict": - type: "boolean" - "schema": + enum: + - "json_schema" + "json_schema": type: "object" - additionalProperties: {} + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" required: - - "name" - - "strict" - - "schema" - required: - - "type" - - "json_schema" - - type: "object" - properties: - "type": - type: "string" - enum: - - "json_object" - required: - - "type" - - type: "null" - description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." - "photoRealVersion": + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": type: "string" enum: - - "v1" - - "v2" - description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" - "encoding_format": + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": type: "string" - enum: - - "float" - - "base64" - description: "The format to return the embeddings" - description: "Model Parameters: Not all parameters apply to every model" - "tools": + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": type: "array" items: type: "object" properties: - "type": + "_id": type: "string" - enum: - - "function" - description: "The type of the tool. Currently, only `function` is supported." - "function": + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": type: "object" properties: - "name": + "stream": + type: "boolean" + "model": type: "string" - description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." - "description": + "model_db_id": type: "string" - description: "A description of what the function does, used by the model to choose when and how to call the function." - "parameters": + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": type: "object" - additionalProperties: {} - description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." - required: - - "name" - required: - - "type" - - "function" - description: "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for." - required: + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + required: + - "count" + - "items" + "CreatePromptRequest": + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "display_name": + type: "string" + "domain_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "key": + type: "string" + "type": + type: "string" + enum: + - "prompt" + - "snippet" + - "template" + required: + - "_id" + - "display_name" + - "domain_id" + - "type" + "DeletePromptRequest": + type: "object" + properties: + "id": + type: "string" + description: "Prompt ID" + required: + - "id" + "DuplicatePromptRequest": + type: "object" + properties: + "id": + type: "string" + description: "Prompt ID" + required: + - "id" + "FindOnePromptRequest": + type: "object" + properties: + "id": + type: "string" + description: "Prompt ID" + required: + - "id" + "GetAllPromptsRequest": + type: "object" + properties: + "filters": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "id" + "id": + type: "string" + "path": + type: "string" + required: + - "type" + - "id" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "search" + "value": + type: "string" + "searchPaths": + type: "array" + items: + type: "string" + required: + - "type" + - "value" + - "searchPaths" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "operator": + type: "string" + enum: + - "contains" + - "equals" + "value": + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "value" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "operator": + type: "string" + enum: + - "in" + "values": + type: "array" + items: + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "values" + - "path" + required: + - "filters" + "UpdatePromptRequest": + type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "domain_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "key": + type: "string" + required: + - "_id" + "PromptCreatePromptResponse": + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "display_name": + type: "string" + "domain_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "key": + type: "string" + "type": + type: "string" + enum: + - "prompt" + - "snippet" + - "template" + required: + - "_id" + - "display_name" + - "domain_id" + - "type" + "GetAllPromptsResponse": + type: "object" + properties: + "count": + type: "number" + "items": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + required: + - "count" + - "items" + "UpdatePromptResponse": + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + "GetOnePromptSnippetByKeyRequest": + type: "object" + properties: + "key": + type: "string" + description: "Prompt Snippet Key" + required: + - "key" + "GetOnePromptSnippetByKeyResponse": + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + "GetRemoteConfigRequest": + type: "object" + properties: + "key": + type: "string" + description: "Remote configuration key" + "context": + type: "object" + additionalProperties: {} + description: "Key-value pairs matching your data model, applied to each prompt key." + "metadata": + type: "object" + additionalProperties: {} + description: "Key-value pairs to attach to the log generated by this request." + required: + - "key" + "GetRemoteConfigResponse": + type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + - "string" + - "integer" + - "decimal" + - "list" + - "json" + - "deployment" + "value": {} + required: + - "type" + "WorkflowRun": + oneOf: + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "remoteconfigs" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig" + "remote_config_id": + type: "string" + required: + - "type" + - "remote_config_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig_variant" + "remote_config_variant_id": + type: "string" + required: + - "type" + - "remote_config_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + "data": + type: "object" + properties: + "remote_config_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_key": + type: "string" + "remote_config_type": + type: "string" + "remote_config_version": + type: "number" + "remote_config_variant_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_variant_position": + type: "number" + "remote_config_value": {} + "is_default_matched": + type: "boolean" + "action": + type: "string" + enum: + - "get_config" + - "simulate" + required: + - "remote_config_id" + - "remote_config_key" + - "remote_config_type" + - "remote_config_version" + - "remote_config_variant_id" + - "remote_config_variant_position" + - "is_default_matched" + - "action" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for a remote config workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "deployments" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_key" + "deployment_key": + type: "string" + required: + - "type" + - "deployment_key" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment" + "deployment_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_variant" + "deployment_variant_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_completion" + "deployment_completion_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "chain" + "chain_id": + type: "string" + required: + - "type" + - "chain_id" + description: "Define the relationship between multiple logs that are part of the same chain" + - type: "object" + properties: + "type": + type: "string" + enum: + - "conversation" + "conversation_id": + type: "string" + required: + - "type" + - "conversation_id" + description: "Define the relationship between multiple logs that are part of the same conversation" + "data": + type: "object" + properties: + "deployment_id": + type: "string" + "deployment_key": + type: "string" + "deployment_variant_version": + type: "string" + "deployment_variant_position": + type: "number" + "deployment_variant_id": + type: "string" + format: "uuid" + "is_default_matched": + type: "boolean" + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "get_config" + - "invoke" + - "simulate" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "retries": + type: "array" + items: + type: "object" + properties: + "retry_attempt": + type: "number" + "status": + type: "number" + "message": + type: "string" + "is_fallback": + type: "boolean" + required: + - "retry_attempt" + - "status" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "metadata": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "settings": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "processing_attempts": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "started_at": + type: "string" + "queued_at": + type: "string" + "completed_at": + type: "string" + "errors": + type: "array" + items: + type: "object" + properties: + "code": + type: "number" + "message": + type: "string" + required: + - "code" + - "message" + required: + - "id" + - "started_at" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + "files": + type: "array" + items: + type: "object" + properties: + "file_id": + type: "string" + "file_name": + type: "string" + "object_name": + type: "string" + "content": + type: "string" + required: + - "file_id" + - "file_name" + - "object_name" + - "content" + "cache_key": + type: "string" + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + "is_caching_enabled": + type: "boolean" + "cache_status": + type: "string" + enum: + - "HIT" + - "MISS" + required: + - "deployment_id" + - "deployment_key" + - "deployment_variant_version" + - "deployment_variant_position" + - "deployment_variant_id" + - "is_default_matched" + - "action" + - "prompt_config" + - "variables" + - "retries" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "playgrounds" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground" + "playground_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_block" + "playground_block_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_block_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_completion" + "playground_completion_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "choices" + - "action" + - "prompt_config" + - "variables" + - "billing" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "experiments" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment" + "experiment_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "experiment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_run" + "experiment_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "experiment_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "test_case_run" + "test_case_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_test_case" + "test_case_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + default: "invoke" + "integration_ids": + type: "array" + items: + type: "string" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the experiment workflow run" + description: "The schema for a workflow run" + "WorkflowRunQueryRequest": + type: "object" + properties: + "pagination": + type: "object" + properties: + "page": + type: "number" + "limit": + type: "number" + "lastId": + type: + - "string" + - "null" + required: + - "limit" + "sortingProps": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + description: "The path to sort by" + "direction": + type: "string" + enum: + - "asc" + - "desc" + description: "The direction to sort by" + required: + - "key" + "query": + type: "object" + properties: + "operator": + type: "string" + enum: + - "and" + - "or" + "filters": + type: "array" + items: + anyOf: + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + "value": {} + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "options": + type: "array" + items: + anyOf: + - type: "string" + - type: "number" + "optionsMap": + type: + - "object" + - "null" + additionalProperties: + anyOf: + - type: "string" + - type: "number" + "imageUrlMap": + type: "object" + additionalProperties: + type: "string" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "id" + - "type" + - "options" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + "value": + type: + - "array" + - "null" + items: {} + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "options": + type: "array" + items: + anyOf: + - type: "string" + - type: "number" + "optionsMap": + type: + - "object" + - "null" + additionalProperties: + anyOf: + - type: "string" + - type: "number" + "imageUrlMap": + type: "object" + additionalProperties: + type: "string" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "options" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + "value": + type: "object" + properties: + "criteria": + type: + - "object" + - "null" + properties: + "unit": + anyOf: + - type: "string" + enum: + - "day" + - "week" + - "month" + - "year" + - type: "string" + enum: + - "hours_ago" + - "minutes_ago" + "count": + type: + - "number" + - "null" + "relativeTime": + type: "string" + enum: + - "today" + - "yesterday" + - "one_week_ago" + - "one_month_ago" + - "custom_date" + "customDate": + type: + - "string" + - "null" + "direction": + type: "string" + enum: + - "present" + - "past" + "startDate": + type: + - "string" + - "null" + "endDate": + type: + - "string" + - "null" + "mode": + type: "string" + enum: + - "date" + - "datetime" + required: + - "criteria" + - "mode" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + "value": + anyOf: + - type: "number" + - type: "array" + items: + type: "number" + - type: "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "name" + - "path" + - type: "object" + properties: + "operator": + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + "value": + anyOf: + - {} + - type: "null" + - type: "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "options": + type: "array" + items: + allOf: + - type: "object" + properties: + "name": + type: "string" + "path": + type: "string" + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "name" + - "path" + - "type" + - type: "object" + properties: + "id": + type: "string" + required: + - "id" + "selectedOptionId": + type: + - "string" + - "null" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "id" + - "type" + - "options" + - "selectedOptionId" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + "value": + type: "boolean" + default: false + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "id" + - "type" + - "name" + - "path" + default: [] + required: + - "operator" + "filters": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "id" + "id": + type: "string" + "path": + type: "string" + required: + - "type" + - "id" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "search" + "value": + type: "string" + "searchPaths": + type: "array" + items: + type: "string" + required: + - "type" + - "value" + - "searchPaths" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "operator": + type: "string" + enum: + - "contains" + - "equals" + "value": + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "value" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "operator": + type: "string" + enum: + - "in" + "values": + type: "array" + items: + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "values" + - "path" + "includedFields": + type: "object" + additionalProperties: + type: "string" + required: + - "filters" + "WorkflowRunQueryResponse": + type: "object" + properties: + "count": + type: "number" + description: "Total number of items" + readOnly: true + "items": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "remoteconfigs" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig" + "remote_config_id": + type: "string" + required: + - "type" + - "remote_config_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig_variant" + "remote_config_variant_id": + type: "string" + required: + - "type" + - "remote_config_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + "data": + type: "object" + properties: + "remote_config_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_key": + type: "string" + "remote_config_type": + type: "string" + "remote_config_version": + type: "number" + "remote_config_variant_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_variant_position": + type: "number" + "remote_config_value": {} + "is_default_matched": + type: "boolean" + "action": + type: "string" + enum: + - "get_config" + - "simulate" + required: + - "remote_config_id" + - "remote_config_key" + - "remote_config_type" + - "remote_config_version" + - "remote_config_variant_id" + - "remote_config_variant_position" + - "is_default_matched" + - "action" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for a remote config workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "deployments" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_key" + "deployment_key": + type: "string" + required: + - "type" + - "deployment_key" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment" + "deployment_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_variant" + "deployment_variant_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_completion" + "deployment_completion_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "chain" + "chain_id": + type: "string" + required: + - "type" + - "chain_id" + description: "Define the relationship between multiple logs that are part of the same chain" + - type: "object" + properties: + "type": + type: "string" + enum: + - "conversation" + "conversation_id": + type: "string" + required: + - "type" + - "conversation_id" + description: "Define the relationship between multiple logs that are part of the same conversation" + "data": + type: "object" + properties: + "deployment_id": + type: "string" + "deployment_key": + type: "string" + "deployment_variant_version": + type: "string" + "deployment_variant_position": + type: "number" + "deployment_variant_id": + type: "string" + format: "uuid" + "is_default_matched": + type: "boolean" + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "get_config" + - "invoke" + - "simulate" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "retries": + type: "array" + items: + type: "object" + properties: + "retry_attempt": + type: "number" + "status": + type: "number" + "message": + type: "string" + "is_fallback": + type: "boolean" + required: + - "retry_attempt" + - "status" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "metadata": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "settings": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "processing_attempts": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "started_at": + type: "string" + "queued_at": + type: "string" + "completed_at": + type: "string" + "errors": + type: "array" + items: + type: "object" + properties: + "code": + type: "number" + "message": + type: "string" + required: + - "code" + - "message" + required: + - "id" + - "started_at" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + "files": + type: "array" + items: + type: "object" + properties: + "file_id": + type: "string" + "file_name": + type: "string" + "object_name": + type: "string" + "content": + type: "string" + required: + - "file_id" + - "file_name" + - "object_name" + - "content" + "cache_key": + type: "string" + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + "is_caching_enabled": + type: "boolean" + "cache_status": + type: "string" + enum: + - "HIT" + - "MISS" + required: + - "deployment_id" + - "deployment_key" + - "deployment_variant_version" + - "deployment_variant_position" + - "deployment_variant_id" + - "is_default_matched" + - "action" + - "prompt_config" + - "variables" + - "retries" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "playgrounds" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground" + "playground_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_block" + "playground_block_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_block_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_completion" + "playground_completion_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "choices" + - "action" + - "prompt_config" + - "variables" + - "billing" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "experiments" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment" + "experiment_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "experiment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_run" + "experiment_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "experiment_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "test_case_run" + "test_case_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_test_case" + "test_case_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + default: "invoke" + "integration_ids": + type: "array" + items: + type: "string" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the experiment workflow run" + description: "The schema for a workflow run" + description: "List of items" + uniqueItems: true + "nextLastId": + type: + - "string" + - "null" + required: + - "count" + - "items" + "HonoApiError": + type: "object" + properties: + "code": + type: "string" + description: "HTTP status code" + "message": + type: "string" + description: "Error message" + required: + - "message" + "Deployments": + type: "object" + properties: + "key": + type: "string" + description: "The deployment id to invoke" + "stream": + type: "boolean" + default: false + description: "If set, partial message content will be sent. Tokens will be sent as data-only `server-sent events` as they become available, with the stream terminated by a `data: [DONE]` message." + "inputs": + type: "object" + additionalProperties: + anyOf: + - type: "string" + - type: "number" + - type: "boolean" + description: "Key-value pairs variables to replace in your prompts. If a variable is not provided that is defined in the prompt, the default variables are used." + "context": + type: "object" + additionalProperties: {} + description: "Key-value pairs that match your data model and fields declared in your configuration matrix. If you send multiple prompt keys, the context will be applied to the evaluation of each key." + "prefix_messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "A list of messages to include after the `System` message, but before the `User` and `Assistant` pairs configured in your deployment." + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "A list of messages to send to the deployment." + "file_ids": + type: "array" + items: + type: "string" + description: "A list of file IDs that are associated with the deployment request." + "metadata": + type: "object" + additionalProperties: {} + description: "Key-value pairs that you want to attach to the log generated by this request." + "chain_id": + type: "string" + description: "Unique ID that identifies a chaining operation. This is useful for tracking a chain of completions across multiple " + "conversation_id": + type: "string" + description: "Unique ID that identifies a chat conversation. This is useful for tracking the same conversation across multiple requests" + "user_id": + anyOf: + - type: "string" + - type: "number" + description: "Unique ID that identifies a user. This is useful for tracking the same user across multiple requests" + "deployment_id": + type: "string" + description: "Unique ID that identifies a deployment entity." + "deployment_variant_id": + type: "string" + description: "Unique ID that identifies a specific variant of a deployment." + "extra_params": + type: "object" + additionalProperties: {} + description: "Utilized for passing additional parameters to the model provider. Exercise caution when using this feature, as the included parameters will overwrite any parameters specified in the deployment prompt configuration." + "invoke_options": + type: "object" + properties: + "include_retrievals": + type: "boolean" + default: false + description: "Whether to include the retrieved knowledge chunks in the response." + required: + - "key" + description: "The deployment request payload" +paths: + "/v2/contacts": + post: + tags: + - "Contacts" + x-speakeasy-name-override: "create" + operationId: "CreateContact" + description: "Update or add user information to workspace" + summary: "Update user information" + requestBody: + required: true + description: "Update user information payload" + content: + "application/json": + schema: + type: "object" + properties: + "external_id": + type: "string" + minLength: 1 + description: "Unique string value to identify the contact user in the customer's system" + "display_name": + type: + - "string" + - "null" + description: "Display name or nickname of the user" + "email": + type: + - "string" + - "null" + format: "email" + description: "Email address of the user" + "avatar_url": + type: + - "string" + - "null" + description: "URL linking to the user's avatar image" + "tags": + type: "array" + items: + type: "string" + format: "uuid" + description: "Array of UUIDs representing tags associated with the user" + "metadata": + type: "object" + additionalProperties: {} + description: "Additional custom metadata associated with the user as key-value pairs" + required: + - "external_id" + responses: + "200": + description: "Successful operation" + content: + "application/json": + schema: + type: "object" + properties: + "id": + type: "string" + description: "Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the user" + "external_id": + type: "string" + minLength: 1 + description: "Unique string value to identify the contact user in the customer's system" + "display_name": + type: + - "string" + - "null" + description: "Display name or nickname of the user" + "email": + type: + - "string" + - "null" + format: "email" + description: "Email address of the user" + "avatar_url": + type: + - "string" + - "null" + description: "URL linking to the user's avatar image" + "tags": + type: "array" + items: + type: "string" + format: "uuid" + description: "Array of UUIDs representing tags associated with the user" + "metadata": + type: "object" + additionalProperties: {} + description: "Additional custom metadata associated with the user as key-value pairs" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + required: + - "id" + - "external_id" + "/v2/feedback": + post: + tags: + - "Feedback" + x-speakeasy-name-override: "create" + operationId: "CreateFeedback" + description: "Submit feedback for the LLM transaction via the API" + summary: "Submit feedback" + requestBody: + required: true + description: "Feedback submission payload" + content: + "application/json": + schema: + type: "object" + properties: + "property": + type: "string" + description: "A string describing the specific property or aspect rated." + x-speakeasy-name-override: "field" + "value": + anyOf: + - type: "string" + - type: "array" + items: + type: "string" + description: "The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string." + "trace_id": + type: "string" + description: "The id returned by the [`get_config`]() or [`invoke`](https://docs.orq.ai/reference/post_deployments-invoke-1) endpoints" + required: + - "property" + - "value" + - "trace_id" + example: {"value": ["good"], "property": "rating", "trace_id": "67HTZ65Z9W91HSF51CW68KK1QH"} + responses: + "200": + description: "Successful operation" + content: + "application/json": + schema: + type: "object" + properties: + "property": + type: "string" + description: "A string describing the specific property or aspect rated." + "value": + anyOf: + - type: "string" + - type: "array" + items: + type: "string" + description: "The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string." + "trace_id": + type: "string" + description: "The id returned by the [`get_config`]() or [`invoke`](https://docs.orq.ai/reference/post_deployments-invoke-1) endpoints" + "id": + type: "string" + required: + - "property" + - "value" + - "trace_id" + - "id" + "/v2/deployments": + get: + tags: + - "Deployments" + x-speakeasy-group: "deployments" + x-speakeasy-name-override: "all" + operationId: "Deployments" + description: "Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first." + summary: "List all deployments" + parameters: + - schema: + type: "number" + minimum: 1 + maximum: 50 + default: 10 + description: "A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10" + required: false + description: "A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10" + name: "limit" + in: "query" + - schema: + type: "string" + description: "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `ed33dade-ae32-4959-8c5c-7ae4aad748b5`, your subsequent call can include `after=ed33dade-ae32-4959-8c5c-7ae4aad748b5` in order to fetch the next page of the list." + required: false + description: "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `ed33dade-ae32-4959-8c5c-7ae4aad748b5`, your subsequent call can include `after=ed33dade-ae32-4959-8c5c-7ae4aad748b5` in order to fetch the next page of the list." + name: "after" + in: "query" + responses: + "200": + description: "List of deployments" + content: + "application/json": + schema: + type: "object" + properties: + "object": + type: "string" + enum: + - "list" + "data": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "Unique identifier for the object." + "created": + type: "string" + description: "Date in ISO 8601 format at which the object was created." + "updated": + type: "string" + description: "Date in ISO 8601 format at which the object was last updated." + "key": + type: "string" + description: "The deployment unique key" + "description": + type: "string" + description: "An arbitrary string attached to the object. Often useful for displaying to users." + "prompt_config": + type: "object" + properties: + "tools": + type: "array" + items: + allOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + - type: "object" + properties: + "id": + type: "number" + "model": + type: "string" + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "tools" + - "model" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "version": + type: "string" + description: "THe version of the deployment" + required: + - "id" + - "created" + - "updated" + - "key" + - "description" + - "prompt_config" + - "version" + "has_more": + type: "boolean" + required: + - "object" + - "data" + - "has_more" + "500": + description: "Internal Server Error" + content: + "application/json": + schema: {"$ref": "#/components/schemas/HonoApiError"} + "/v2/deployments/invalidate/{deployment_id}": + delete: + tags: + - "Deployments" + x-speakeasy-group: "deployments" + x-speakeasy-name-override: "invalidate" + operationId: "InvalidDeployment" + description: "Explicitly invalidate a cache of a deployment" + summary: "Invalidates cache" + security: + - ApiKey: [] + parameters: + - schema: + anyOf: + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + description: "The deployment id that needs to be invalidated" + required: true + name: "deployment_id" + in: "path" + responses: + "204": + description: "No content - successful operation" + "/v2/deployments/get_config": + post: + tags: + - "Deployments" + x-speakeasy-group: "deployments" + x-speakeasy-name-override: "getConfig" + operationId: "DeploymentGetConfig" + description: "Retrieve the deployment configuration" + summary: "Get config" + requestBody: + required: true + content: + "application/json": + schema: + type: "object" + properties: + "key": + type: "string" + description: "The deployment id to invoke" + "inputs": + type: "object" + additionalProperties: + anyOf: + - type: "string" + - type: "number" + - type: "boolean" + description: "Key-value pairs variables to replace in your prompts. If a variable is not provided that is defined in the prompt, the default variables are used." + "context": + type: "object" + additionalProperties: {} + description: "Key-value pairs that match your data model and fields declared in your configuration matrix. If you send multiple prompt keys, the context will be applied to the evaluation of each key." + "prefix_messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "A list of messages to include after the `System` message, but before the `User` and `Assistant` pairs configured in your deployment." + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "A list of messages to send to the deployment." + "file_ids": + type: "array" + items: + type: "string" + description: "A list of file IDs that are associated with the deployment request." + "metadata": + type: "object" + additionalProperties: {} + description: "Key-value pairs that you want to attach to the log generated by this request." + "chain_id": + type: "string" + description: "Unique ID that identifies a chaining operation. This is useful for tracking a chain of completions across multiple " + "conversation_id": + type: "string" + description: "Unique ID that identifies a chat conversation. This is useful for tracking the same conversation across multiple requests" + "user_id": + anyOf: + - type: "string" + - type: "number" + description: "Unique ID that identifies a user. This is useful for tracking the same user across multiple requests" + "deployment_id": + type: "string" + description: "Unique ID that identifies a deployment entity." + "deployment_variant_id": + type: "string" + description: "Unique ID that identifies a specific variant of a deployment." + "extra_params": + type: "object" + additionalProperties: {} + description: "Utilized for passing additional parameters to the model provider. Exercise caution when using this feature, as the included parameters will overwrite any parameters specified in the deployment prompt configuration." + "invoke_options": + type: "object" + properties: + "include_retrievals": + type: "boolean" + default: false + description: "Whether to include the retrieved knowledge chunks in the response." + required: + - "key" + responses: + "200": + description: "Configurations Retrieved." + content: + "application/json": + schema: + type: "object" + properties: + "id": + type: "string" + description: "A unique identifier for the response. Can be used to add metrics to the transaction." + "provider": + type: "string" + description: "The provider of the model" + "model": + type: "string" + description: "The model of the configuration" + "type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model. Current `chat`,`completion` and `image` are supported" + "version": + type: "string" + description: "The current version of the deployment" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + "parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "parameters": + type: "object" + additionalProperties: {} + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + required: + - "type" + - "function" + description: "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for." + required: + - "id" + - "provider" + - "model" + - "version" + - "messages" + - "parameters" + description: "The deployment configuration" + "204": + description: "No content - successful operation" + "401": + description: "Unauthorized." + "/v2/deployments/invoke": + post: + tags: + - "Deployments" + x-speakeasy-group: "deployments" + x-speakeasy-name-override: "invoke" + operationId: "DeploymentInvoke" + description: "Invoke a deployment with a given payload" + summary: "Invoke" + requestBody: + required: true + content: + "application/json": + schema: {"$ref": "#/components/schemas/Deployments"} + responses: + "200": + description: "Successful operation" + content: + "application/json": + schema: + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "A unique identifier for the response. Can be used to add metrics to the transaction." + readOnly: true + "created": + type: "string" + format: "date-time" + description: "A timestamp indicating when the object was created. Usually in a standardized format like ISO 8601" + "object": + type: "string" + enum: + - "chat" + - "completion" + - "image" + description: "Indicates the type of model used to generate the response" + "model": + type: "string" + description: "The model used to generate the response" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + description: "The provider used to generate the response" + "is_final": + type: "boolean" + description: "Indicates if the response is the final response" + "integration_id": + type: "string" + description: "Indicates integration id used to generate the response" + "finalized": + type: "string" + format: "date-time" + description: "A timestamp indicating when the object was finalized. Usually in a standardized format like ISO 8601" + "system_fingerprint": + type: + - "string" + - "null" + description: "Provider backed system fingerprint." + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + description: "A list of choices generated by the model" + "retrievals": + type: "array" + items: + type: "object" + properties: + "document": + type: "string" + description: "Content of the retrieved chunk from the knowledge base" + "metadata": + type: "object" + properties: + "file_name": + type: "string" + description: "Name of the file" + "page_number": + type: + - "number" + - "null" + description: "Page number of the chunk" + "file_type": + type: "string" + description: "Type of the file" + "rerank_score": + type: "number" + description: "Rerank scores are normalized to be in the range [0, 1]. Scores close to 1 indicate a high relevance to the query, and scores closer to 0 indicate low relevance. It is not accurate to assume a score of 0.9 means the document is 2x more relevant than a document with a score of 0.45" + "search_score": + type: "number" + description: "Search scores are normalized to be in the range [0, 1]. Search score is calculated based on `[Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity)` algorithm. Scores close to 1 indicate the document is closer to the query, and scores closer to 0 indicate the document is farther from the query." + required: + - "file_name" + - "page_number" + - "file_type" + - "search_score" + description: "Metadata of the retrieved chunk from the knowledge base" + required: + - "document" + - "metadata" + description: "List of documents retrieved from the knowledge base. This property is only available when the `include_retrievals` flag is set to `true` in the invoke settings. When stream is set to true, the `retrievals` property will be returned in the last streamed chunk where the property `is_final` is set to `true`." + "provider_response": + description: "Response returned by the model provider. This functionality is only supported when streaming is not used. If streaming is used, the `provider_response` property will be set to `null`." + required: + - "id" + - "created" + - "object" + - "model" + - "provider" + - "is_final" + - "choices" + description: "Response from the gateway" + "text/event-stream": + schema: + type: "object" + properties: + "data": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "A unique identifier for the response. Can be used to add metrics to the transaction." + readOnly: true + "created": + type: "string" + format: "date-time" + description: "A timestamp indicating when the object was created. Usually in a standardized format like ISO 8601" + "object": + type: "string" + enum: + - "chat" + - "completion" + - "image" + description: "Indicates the type of model used to generate the response" + "model": + type: "string" + description: "The model used to generate the response" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + description: "The provider used to generate the response" + "is_final": + type: "boolean" + description: "Indicates if the response is the final response" + "integration_id": + type: "string" + description: "Indicates integration id used to generate the response" + "finalized": + type: "string" + format: "date-time" + description: "A timestamp indicating when the object was finalized. Usually in a standardized format like ISO 8601" + "system_fingerprint": + type: + - "string" + - "null" + description: "Provider backed system fingerprint." + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + description: "A list of choices generated by the model" + "retrievals": + type: "array" + items: + type: "object" + properties: + "document": + type: "string" + description: "Content of the retrieved chunk from the knowledge base" + "metadata": + type: "object" + properties: + "file_name": + type: "string" + description: "Name of the file" + "page_number": + type: + - "number" + - "null" + description: "Page number of the chunk" + "file_type": + type: "string" + description: "Type of the file" + "rerank_score": + type: "number" + description: "Rerank scores are normalized to be in the range [0, 1]. Scores close to 1 indicate a high relevance to the query, and scores closer to 0 indicate low relevance. It is not accurate to assume a score of 0.9 means the document is 2x more relevant than a document with a score of 0.45" + "search_score": + type: "number" + description: "Search scores are normalized to be in the range [0, 1]. Search score is calculated based on `[Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity)` algorithm. Scores close to 1 indicate the document is closer to the query, and scores closer to 0 indicate the document is farther from the query." + required: + - "file_name" + - "page_number" + - "file_type" + - "search_score" + description: "Metadata of the retrieved chunk from the knowledge base" + required: + - "document" + - "metadata" + description: "List of documents retrieved from the knowledge base. This property is only available when the `include_retrievals` flag is set to `true` in the invoke settings. When stream is set to true, the `retrievals` property will be returned in the last streamed chunk where the property `is_final` is set to `true`." + "provider_response": + description: "Response returned by the model provider. This functionality is only supported when streaming is not used. If streaming is used, the `provider_response` property will be set to `null`." + required: + - "id" + - "created" + - "object" + - "model" + - "provider" + - "is_final" + - "choices" + description: "Response from the gateway" + x-speakeasy-sse-sentinel: "[DONE]" + "204": + description: "No content - successful operation" + "/v2/deployments/{id}/metrics": + post: + tags: + - "Deployments" + x-speakeasy-group: "deployments.metrics" + x-speakeasy-name-override: "create" + operationId: "DeploymentCreateMetric" + description: "Add metrics to a deployment" + summary: "Add metrics" + parameters: + - schema: + type: "string" + description: "Deployment ID" + required: true + description: "Deployment ID" + name: "id" + in: "path" + requestBody: + required: true + description: "The deployment request payload" + content: + "application/json": + schema: + type: "object" + properties: + "metadata": + type: "object" + additionalProperties: {} + description: "Your own custom key-value pairs can be attached to the logs. This is useful for storing additional information related to your interactions with the LLM providers or specifics within your application." + "usage": + type: "object" + properties: + "prompt_tokens": + type: "number" + description: "Number of tokens in the prompt." + "completion_tokens": + type: "number" + description: "Number of tokens in the generated completion." + "total_tokens": + type: "number" + description: "Total number of tokens used in the request (prompt + completion)." + required: + - "prompt_tokens" + - "completion_tokens" + description: "Usage statistics to add to the deployment" + "performance": + type: "object" + properties: + "latency": + type: "number" + description: "Total time in milliseconds of the request to the LLM provider API." + "time_to_first_token": + type: "number" + description: "Total time in milliseconds to generate the first token of the completion." + required: + - "latency" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "A list of messages sent to the model." + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + description: "A list of completion choices. If you are using a `completion` model then you must provide the `completion content` with the chat completion format" + "feedback": + type: "object" + properties: + "score": + type: "integer" + minimum: 0 + maximum: 100 + description: "The feedback score. This allow you to come with specific logic on what a `score` number means" + required: + - "score" + description: "Feedback from the user on the completion" + responses: + "200": + description: "Successful operation" + content: + "application/json": + schema: + type: "object" + properties: + "code": + type: "number" + description: "The status code of the request" + "success": + type: "boolean" + description: "Whether the request was successful" + required: + - "code" + - "success" + "400": + description: "Bad Request" + "401": + description: "Unauthorized." + "/v2/files": + post: + tags: + - "Files" + x-speakeasy-group: "files" + x-speakeasy-name-override: "upload" + operationId: "FileUpload" + summary: "Upload file" + description: "Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config)." + requestBody: + required: true + content: + "multipart/form-data": + schema: + type: "object" + properties: + "file": + type: "string" + description: "The file to be uploaded." + format: "binary" + "purpose": + type: "string" + enum: + - "retrieval" + default: "retrieval" + description: "The intended purpose of the uploaded file." + responses: + "200": + description: "File uploaded successfully" + content: + "application/json": + schema: + type: "object" + properties: + "_id": + type: "string" + "object_name": + type: "string" + description: "path to the file in the storage" + "purpose": + type: "string" + enum: + - "retrieval" + description: "The intended purpose of the uploaded file." + "bytes": + type: "number" + "file_name": + type: "string" + "created": + type: "string" + format: "date-time" + default: "2024-12-01T21:30:45.101Z" + description: "The date and time the resource was created" + readOnly: true + required: + - "_id" + - "object_name" + - "purpose" + - "bytes" + - "file_name" + "400": + description: "Bad request" + "/v2/files/bulk": + post: + tags: + - "Files" + x-speakeasy-group: "files" + x-speakeasy-name-override: "bulkUpload" + operationId: "BulkFileUpload" + summary: "Bulk upload file" + description: "Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config)." + requestBody: + required: true + content: + "multipart/form-data": + schema: + type: "object" + properties: + "files": + type: "array" + items: + type: "string" + description: "The file to be uploaded." + format: "binary" + "purpose": + type: "string" + enum: + - "retrieval" + description: "The intended purpose of the uploaded file." + required: + - "files" + - "purpose" + responses: + "200": + description: "Bulk files uploaded successfully" + content: + "application/json": + schema: + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "object_name": + type: "string" + description: "path to the file in the storage" + "purpose": + type: "string" + enum: + - "retrieval" + description: "The intended purpose of the uploaded file." + "bytes": + type: "number" + "file_name": + type: "string" + "created": + type: "string" + format: "date-time" + default: "2024-12-01T21:30:45.101Z" + description: "The date and time the resource was created" + readOnly: true + required: + - "_id" + - "object_name" + - "purpose" + - "bytes" + - "file_name" + "400": + description: "Bad request" + "/v2/resources/datasets": + post: + tags: + - "resources" + x-speakeasy-group: "dataset" + x-speakeasy-name-override: "create" + x-speakeasy-ignore: true + operationId: "CreateDataset" + security: + - ApiKey: [] + description: "Create a dataset" + summary: "Create a dataset" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + required: + - "display_name" + - "domain_id" + responses: + "200": + description: "Dataset Created." + content: + "application/json": + schema: + type: "object" + properties: + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + required: + - "display_name" + - "domain_id" + get: + tags: + - "resources" + x-speakeasy-group: "dataset" + x-speakeasy-name-override: "getAll" + x-speakeasy-ignore: true + operationId: "GetAllDataset" + security: + - ApiKey: [] + summary: "Get all datasets" + parameters: + - schema: + type: "number" + required: false + name: "page" + in: "query" + - schema: + type: "number" + required: false + name: "limit" + in: "query" + responses: + "200": + description: "Datasets Retrieved." + content: + "application/json": + schema: + type: "object" + properties: + "count": + type: "number" + "page": + type: "number" + "limit": + type: "number" + "totalPages": + type: "number" + "items": + type: "array" + items: + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + "updated_by": + type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "email": + type: "string" + format: "email" + description: "Email of the user" + "display_name": + type: "string" + description: "Display name of the user" + "logo_url": + type: + - "string" + - "null" + format: "uri" + description: "URL of the user logo" + required: + - "id" + - "email" + - "display_name" + - "logo_url" + description: "User model returned from the API" + "updated_by_id": + type: + - "string" + - "null" + format: "uuid" + description: "The user who last updated the dataset" + "items": + type: "array" + items: + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset row model from the API." + required: + - "id" + - "display_name" + - "domain_id" + - "updated_by" + - "updated_by_id" + - "items" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset model from the API" + required: + - "count" + - "page" + - "limit" + - "totalPages" + - "items" + "/v2/resources/datasets/{dataset_id}": + delete: + tags: + - "resources" + x-speakeasy-group: "dataset" + x-speakeasy-name-override: "delete" + x-speakeasy-ignore: true + operationId: "DeleteDataset" + security: + - ApiKey: [] + summary: "Delete a dataset" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + responses: + "204": + description: "No content - successful operation" + "404": + description: "Dataset not found" + get: + tags: + - "resources" + x-speakeasy-group: "dataset" + x-speakeasy-name-override: "getOne" + x-speakeasy-ignore: true + operationId: "GetOneDataset" + security: + - ApiKey: [] + summary: "Get one dataset" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + responses: + "200": + description: "Dataset retrieved." + content: + "application/json": + schema: + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + "updated_by": + type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "email": + type: "string" + format: "email" + description: "Email of the user" + "display_name": + type: "string" + description: "Display name of the user" + "logo_url": + type: + - "string" + - "null" + format: "uri" + description: "URL of the user logo" + required: + - "id" + - "email" + - "display_name" + - "logo_url" + description: "User model returned from the API" + "updated_by_id": + type: + - "string" + - "null" + format: "uuid" + description: "The user who last updated the dataset" + "items": + type: "array" + items: + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset row model from the API." + required: + - "id" + - "display_name" + - "domain_id" + - "updated_by" + - "updated_by_id" + - "items" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset model from the API" + "404": + description: "Dataset not found with the given id" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + patch: + tags: + - "resources" + x-speakeasy-group: "dataset" + x-speakeasy-name-override: "update" + x-speakeasy-ignore: true + operationId: "UpdateDataset" + security: + - ApiKey: [] + description: "Update a dataset" + summary: "Update a dataset" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + responses: + "200": + description: "Dataset updated." + content: + "application/json": + schema: + type: "object" + properties: + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + "/v2/resources/datasets/{dataset_id}/rows/bulk": + post: + tags: + - "resources" + x-speakeasy-group: "dataset.rows" + x-speakeasy-name-override: "createBulk" + x-speakeasy-ignore: true + operationId: "CreateBulkDatasetRows" + security: + - ApiKey: [] + description: "Create a list of dataset rows" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "datasetRows": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + description: "Expected dataset row model when talking to the API." + example: {"id": "uuid-string", "messages": [{"role": "assistant", "content": "You are a helpful assistant.", "tool_calls": [{"id": "tool-id", "index": 0, "type": "function", "function": {"name": "some-function", "arguments": "some-args"}}]}]} + required: + - "datasetRows" + responses: + "200": + description: "Dataset rows created." + content: + "application/json": + schema: + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + description: "Expected dataset row model when talking to the API." + example: {"id": "uuid-string", "messages": [{"role": "assistant", "content": "You are a helpful assistant.", "tool_calls": [{"id": "tool-id", "index": 0, "type": "function", "function": {"name": "some-function", "arguments": "some-args"}}]}]} + delete: + tags: + - "resources" + x-speakeasy-group: "dataset.rows" + x-speakeasy-name-override: "deleteBulk" + x-speakeasy-ignore: true + operationId: "DeleteBulkDatasetRows" + security: + - ApiKey: [] + summary: "Delete a list of dataset rows" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + responses: + "200": + description: "Dataset rows deleted." + "/v2/resources/datasets/{dataset_id}/rows": + post: + tags: + - "resources" + x-speakeasy-group: "dataset.rows" + x-speakeasy-name-override: "create" + x-speakeasy-ignore: true + operationId: "CreateDatasetRow" + security: + - ApiKey: [] + description: "Create a dataset row" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + responses: + "200": + description: "Dataset row created." + content: + "application/json": + schema: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: - "id" - - "provider" - - "model" - - "version" - "messages" - - "parameters" - description: "The deployment configuration" - "204": - description: "No content - successful operation" + description: "Expected dataset row model when talking to the API." + example: {"id": "uuid-string", "messages": [{"role": "assistant", "content": "You are a helpful assistant.", "tool_calls": [{"id": "tool-id", "index": 0, "type": "function", "function": {"name": "some-function", "arguments": "some-args"}}]}]} + get: + tags: + - "resources" + x-speakeasy-group: "dataset.rows" + x-speakeasy-name-override: "getAll" + x-speakeasy-ignore: true + operationId: "GetAllDatasetRows" + security: + - ApiKey: [] + description: "Retrieve all dataset rows" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + responses: + "200": + description: "Dataset rows Retrieved." + content: + "application/json": + schema: + type: "object" + properties: + "count": + type: "number" + "page": + type: "number" + "limit": + type: "number" + "totalPages": + type: "number" + "items": + type: "array" + items: + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset row model from the API." + required: + - "count" + - "page" + - "limit" + - "totalPages" + - "items" + "/v2/resources/datasets/{dataset_id}/rows/{row_id}": + delete: + tags: + - "resources" + x-speakeasy-group: "dataset.rows" + x-speakeasy-name-override: "delete" + x-speakeasy-ignore: true + operationId: "DeleteDatasetRow" + security: + - ApiKey: [] + summary: "Delete a dataset row" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + - schema: + type: "string" + description: "Dataset row ID" + required: true + description: "Dataset row ID" + name: "row_id" + in: "path" + responses: + "200": + description: "Dataset row deleted." + get: + tags: + - "resources" + x-speakeasy-group: "dataset.rows" + x-speakeasy-name-override: "getOne" + x-speakeasy-ignore: true + operationId: "GetOneDatasetRow" + security: + - ApiKey: [] + summary: "Get one dataset row" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + - schema: + type: "string" + description: "Dataset row ID" + required: true + description: "Dataset row ID" + name: "row_id" + in: "path" + responses: + "200": + description: "Dataset row retrieved." + content: + "application/json": + schema: + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset row model from the API." + "404": + description: "Dataset row not found with the given id" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + patch: + tags: + - "resources" + x-speakeasy-group: "dataset.rows" + x-speakeasy-name-override: "update" + x-speakeasy-ignore: true + operationId: "UpdateDatasetRow" + security: + - ApiKey: [] + description: "Update a dataset row" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + - schema: + type: "string" + description: "Dataset row ID" + required: true + description: "Dataset row ID" + name: "row_id" + in: "path" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "messages" + responses: + "200": + description: "Dataset updated." + content: + "application/json": + schema: + type: "object" + properties: + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "messages" + "/v2/resources/evaluators/templates": + get: + tags: + - "Evaluators" + x-speakeasy-group: "evals.templates" + x-speakeasy-name-override: "all" + x-speakeasy-ignore: true + operationId: "GetEvalTemplates" + description: "List evaluators templates" + summary: "Templates" + responses: + "200": + description: "Successful operation" + content: + "application/json": + schema: + type: "object" + properties: + "object": + type: "string" + enum: + - "list" + "data": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "prompt": + type: "string" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + required: + - "_id" + - "display_name" + - "description" + - "prompt" + - "output_type" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "function": + type: "string" + enum: + - "is_valid_json" + - "bert_score" + - "bleu_score" + - "rouge_n" + - "meteor_score" + - "cosine_similarity" + - "levenshtein_distance" + - "exact_match" + - "contains" + - "contains_all" + - "contains_any" + - "contains_email" + - "contains_url" + - "contains_none" + - "contains_valid_link" + - "ends_with" + - "length_between" + - "length_greater_than" + - "length_less_than" + - "moderations_openai" + - "moderations_google" + - "one_line" + - "regex" + - "start_with" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + required: + - "_id" + - "display_name" + - "description" + - "function" + - "output_type" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + "type": + type: "string" + enum: + - "ragas" + required: + - "_id" + - "display_name" + - "description" + - "ragas_metric" + - "type" + "has_more": + type: "boolean" + required: + - "object" + - "data" + - "has_more" + "/v2/resources/evaluators": + get: + tags: + - "evals" + x-speakeasy-group: "evals" + x-speakeasy-name-override: "all" + x-speakeasy-ignore: true + operationId: "GetEvals" + summary: "Get all evals" + security: + - ApiKey: [] + responses: + "200": + description: "Returns a list of evals" + content: + "application/json": + schema: + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "prompt": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "prompt" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + "function_params": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_none" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_all" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_any" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_email" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_url" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_valid_link" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "start_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "ends_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact_match" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_less_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_between" + "min": + type: "number" + "max": + type: "number" + required: + - "type" + - "min" + - "max" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_greater_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "one_line" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "regex" + "pattern": + type: "string" + required: + - "type" + - "pattern" + - type: "object" + properties: + "type": + type: "string" + enum: + - "is_valid_json" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_openai" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_google" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bleu_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "meteor_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "cosine_similarity" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "levenshtein_distance" + required: + - "type" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "function_params" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "number" + "type": + type: "string" + enum: + - "ragas" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "ragas_metric" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + "type": + type: "string" + enum: + - "json_schema" + "schema": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "schema" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "http_eval" + "url": + type: "string" + "method": + type: "string" + enum: + - "GET" + - "POST" + "headers": + type: "object" + additionalProperties: + type: "string" + "payload": + type: "object" + additionalProperties: {} + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "url" + - "method" + - "headers" + - "payload" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "python_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "typescript_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + "404": + description: "Workspace ID is not found on the request" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + post: + tags: + - "evals" + x-speakeasy-group: "evals" + x-speakeasy-name-override: "create" + x-speakeasy-ignore: true + operationId: "CreateEval" + summary: "Create an evaluator" + security: + - ApiKey: [] + requestBody: + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "prompt": + type: "string" + required: + - "display_name" + - "description" + - "metadata" + - "domain_id" + - "output_type" + - "type" + - "model" + - "prompt" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "number" + "type": + type: "string" + enum: + - "ragas" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + required: + - "display_name" + - "description" + - "metadata" + - "domain_id" + - "output_type" + - "type" + - "model" + - "ragas_metric" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + "type": + type: "string" + enum: + - "json_schema" + "schema": + type: "string" + required: + - "display_name" + - "description" + - "metadata" + - "domain_id" + - "output_type" + - "type" + - "schema" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "http_eval" + "url": + type: "string" + "method": + type: "string" + enum: + - "GET" + - "POST" + "headers": + type: "object" + additionalProperties: + type: "string" + "payload": + type: "object" + additionalProperties: {} + required: + - "display_name" + - "description" + - "metadata" + - "domain_id" + - "output_type" + - "type" + - "url" + - "method" + - "headers" + - "payload" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "python_eval" + required: + - "display_name" + - "description" + - "metadata" + - "domain_id" + - "output_type" + - "code" + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "typescript_eval" + required: + - "display_name" + - "description" + - "metadata" + - "domain_id" + - "output_type" + - "code" + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + "function_params": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_none" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_all" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_any" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_email" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_url" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_valid_link" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "start_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "ends_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact_match" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_less_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_between" + "min": + type: "number" + "max": + type: "number" + required: + - "type" + - "min" + - "max" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_greater_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "one_line" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "regex" + "pattern": + type: "string" + required: + - "type" + - "pattern" + - type: "object" + properties: + "type": + type: "string" + enum: + - "is_valid_json" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_openai" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_google" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bleu_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "meteor_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "cosine_similarity" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "levenshtein_distance" + required: + - "type" + required: + - "display_name" + - "description" + - "metadata" + - "domain_id" + - "output_type" + - "type" + - "function_params" + responses: + "200": + description: "Successfully created an evaluator" + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "prompt": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "prompt" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + "function_params": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_none" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_all" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_any" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_email" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_url" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_valid_link" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "start_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "ends_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact_match" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_less_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_between" + "min": + type: "number" + "max": + type: "number" + required: + - "type" + - "min" + - "max" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_greater_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "one_line" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "regex" + "pattern": + type: "string" + required: + - "type" + - "pattern" + - type: "object" + properties: + "type": + type: "string" + enum: + - "is_valid_json" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_openai" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_google" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bleu_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "meteor_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "cosine_similarity" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "levenshtein_distance" + required: + - "type" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "function_params" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "number" + "type": + type: "string" + enum: + - "ragas" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "ragas_metric" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + "type": + type: "string" + enum: + - "json_schema" + "schema": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "schema" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "http_eval" + "url": + type: "string" + "method": + type: "string" + enum: + - "GET" + - "POST" + "headers": + type: "object" + additionalProperties: + type: "string" + "payload": + type: "object" + additionalProperties: {} + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "url" + - "method" + - "headers" + - "payload" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "python_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "typescript_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + "403": + description: "Domain is not allowed" + "404": + description: "Workspace ID is not found on the request" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + "/v2/resources/evaluators/{id}": + get: + tags: + - "evals" + x-speakeasy-group: "evals" + x-speakeasy-name-override: "get" + x-speakeasy-ignore: true + operationId: "GetEval" + summary: "Get an eval" + security: + - ApiKey: [] + parameters: + - schema: + type: "string" + required: true + name: "id" + in: "path" + responses: + "200": + description: "Returns a single eval" + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "prompt": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "prompt" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + "function_params": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_none" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_all" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_any" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_email" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_url" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_valid_link" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "start_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "ends_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact_match" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_less_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_between" + "min": + type: "number" + "max": + type: "number" + required: + - "type" + - "min" + - "max" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_greater_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "one_line" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "regex" + "pattern": + type: "string" + required: + - "type" + - "pattern" + - type: "object" + properties: + "type": + type: "string" + enum: + - "is_valid_json" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_openai" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_google" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bleu_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "meteor_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "cosine_similarity" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "levenshtein_distance" + required: + - "type" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "function_params" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "number" + "type": + type: "string" + enum: + - "ragas" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "ragas_metric" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + "type": + type: "string" + enum: + - "json_schema" + "schema": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "schema" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "http_eval" + "url": + type: "string" + "method": + type: "string" + enum: + - "GET" + - "POST" + "headers": + type: "object" + additionalProperties: + type: "string" + "payload": + type: "object" + additionalProperties: {} + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "url" + - "method" + - "headers" + - "payload" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "python_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "typescript_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + "404": + description: "Workspace ID is not found on the request" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + patch: + tags: + - "evals" + x-speakeasy-group: "evals" + x-speakeasy-name-override: "update" + x-speakeasy-ignore: true + operationId: "UpdateEval" + summary: "Update an eval" + security: + - ApiKey: [] + parameters: + - schema: + type: "string" + required: true + name: "id" + in: "path" + requestBody: + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "prompt": + type: "string" + required: + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "number" + "type": + type: "string" + enum: + - "ragas" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + required: + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + "type": + type: "string" + enum: + - "json_schema" + "schema": + type: "string" + required: + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "http_eval" + "url": + type: "string" + "method": + type: "string" + enum: + - "GET" + - "POST" + "headers": + type: "object" + additionalProperties: + type: "string" + "payload": + type: "object" + additionalProperties: {} + required: + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "python_eval" + required: + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "typescript_eval" + required: + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + "function_params": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_none" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_all" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_any" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_email" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_url" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_valid_link" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "start_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "ends_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact_match" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_less_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_between" + "min": + type: "number" + "max": + type: "number" + required: + - "type" + - "min" + - "max" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_greater_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "one_line" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "regex" + "pattern": + type: "string" + required: + - "type" + - "pattern" + - type: "object" + properties: + "type": + type: "string" + enum: + - "is_valid_json" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_openai" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_google" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bleu_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "meteor_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "cosine_similarity" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "levenshtein_distance" + required: + - "type" + required: + - "type" + responses: + "200": + description: "Successfully updated an eval" + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "prompt": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "prompt" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + "function_params": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_none" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_all" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_any" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_email" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_url" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_valid_link" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "start_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "ends_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact_match" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_less_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_between" + "min": + type: "number" + "max": + type: "number" + required: + - "type" + - "min" + - "max" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_greater_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "one_line" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "regex" + "pattern": + type: "string" + required: + - "type" + - "pattern" + - type: "object" + properties: + "type": + type: "string" + enum: + - "is_valid_json" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_openai" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_google" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bleu_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "meteor_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "cosine_similarity" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "levenshtein_distance" + required: + - "type" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "function_params" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "number" + "type": + type: "string" + enum: + - "ragas" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "ragas_metric" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + "type": + type: "string" + enum: + - "json_schema" + "schema": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "schema" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "http_eval" + "url": + type: "string" + "method": + type: "string" + enum: + - "GET" + - "POST" + "headers": + type: "object" + additionalProperties: + type: "string" + "payload": + type: "object" + additionalProperties: {} + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "url" + - "method" + - "headers" + - "payload" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "python_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "typescript_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + "404": + description: "Workspace ID is not found on the request" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + delete: + tags: + - "evals" + x-speakeasy-group: "evals" + x-speakeasy-name-override: "delete" + x-speakeasy-ignore: true + operationId: "DeleteEval" + summary: "Delete an eval" + parameters: + - schema: + type: "string" + required: true + name: "id" + in: "path" + responses: + "200": + description: "Eval deleted" + "404": + description: "Workspace ID is not found on the request" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + "/v2/resources/evaluators/{id}/duplicate": + post: + tags: + - "evals" + x-speakeasy-group: "evals" + x-speakeasy-name-override: "duplicate" + x-speakeasy-ignore: true + operationId: "DuplicateEval" + summary: "Duplicate an evaluator" + security: + - ApiKey: [] + parameters: + - schema: + type: "string" + required: true + name: "id" + in: "path" + responses: + "200": + description: "Successfully duplicated the evaluator" + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "prompt": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "prompt" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + "function_params": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_none" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_all" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_any" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_email" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_url" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_valid_link" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "start_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "ends_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact_match" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_less_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_between" + "min": + type: "number" + "max": + type: "number" + required: + - "type" + - "min" + - "max" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_greater_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "one_line" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "regex" + "pattern": + type: "string" + required: + - "type" + - "pattern" + - type: "object" + properties: + "type": + type: "string" + enum: + - "is_valid_json" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_openai" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_google" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bleu_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "meteor_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "cosine_similarity" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "levenshtein_distance" + required: + - "type" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "function_params" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "number" + "type": + type: "string" + enum: + - "ragas" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "ragas_metric" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + "type": + type: "string" + enum: + - "json_schema" + "schema": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "schema" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "http_eval" + "url": + type: "string" + "method": + type: "string" + enum: + - "GET" + - "POST" + "headers": + type: "object" + additionalProperties: + type: "string" + "payload": + type: "object" + additionalProperties: {} + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "url" + - "method" + - "headers" + - "payload" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "python_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "typescript_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + "403": + description: "Domain is not allowed" + "404": + description: "Workspace ID is not found on the request" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + "/v2/resources/prompts/templates/query": + post: + tags: + - "resources" + x-speakeasy-group: "prompt.templates" + x-speakeasy-name-override: "getAll" + operationId: "GetAllPromptTemplates" + security: + - ApiKey: [] + summary: "Get all prompt templates" + parameters: + - schema: + type: "string" + required: false + name: "page" + in: "query" + - schema: + type: "string" + required: false + name: "limit" + in: "query" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "filters": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "id" + "id": + type: "string" + "path": + type: "string" + required: + - "type" + - "id" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "search" + "value": + type: "string" + "searchPaths": + type: "array" + items: + type: "string" + required: + - "type" + - "value" + - "searchPaths" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "operator": + type: "string" + enum: + - "contains" + - "equals" + "value": + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "value" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "operator": + type: "string" + enum: + - "in" + "values": + type: "array" + items: + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "values" + - "path" + required: + - "filters" + responses: + "200": + description: "Prompt templates retrieved." + content: + "application/json": + schema: + type: "object" + properties: + "count": + type: "number" + "items": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + required: + - "count" + - "items" + "400": + description: "Bad Request" + "/v2/resources/prompts": + post: + tags: + - "resources" + x-speakeasy-group: "prompts" + x-speakeasy-name-override: "create" + operationId: "CreatePrompt" + security: + - ApiKey: [] + summary: "Create a new prompt" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "display_name": + type: "string" + "domain_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "key": + type: "string" + "type": + type: "string" + enum: + - "prompt" + - "snippet" + - "template" + required: + - "_id" + - "display_name" + - "domain_id" + - "type" + responses: + "200": + description: "Prompt created." + content: + "application/json": + schema: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "display_name": + type: "string" + "domain_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "key": + type: "string" + "type": + type: "string" + enum: + - "prompt" + - "snippet" + - "template" + required: + - "_id" + - "display_name" + - "domain_id" + - "type" + example: {"_id": "ulid-string", "type": "prompt", "display_name": "string", "domain_id": "uuid-string", "description": "Sample description for the prompt"} + "/v2/resources/prompts/{id}/versions": + post: + tags: + - "resources" + x-speakeasy-group: "prompts" + x-speakeasy-name-override: "createVersion" + operationId: "CreatePromptVersion" + security: + - ApiKey: [] + summary: "Create a new prompt version" + parameters: + - schema: + type: "string" + description: "Prompt ID" + required: true + description: "Prompt ID" + name: "id" + in: "path" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "display_name": + type: "string" + maxLength: 128 + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "display_name" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + responses: + "200": + description: "Prompt version created." + content: + "application/json": + schema: + type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + maxLength: 128 + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "display_name" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + "/v2/resources/prompts/{id}": + delete: + tags: + - "resources" + x-speakeasy-group: "prompts" + x-speakeasy-name-override: "delete" + operationId: "DeletePrompt" + security: + - ApiKey: [] + summary: "Delete a prompt" + parameters: + - schema: + type: "string" + description: "Prompt ID" + required: true + description: "Prompt ID" + name: "id" + in: "path" + responses: + "200": + description: "Prompt deleted." + get: + tags: + - "resources" + x-speakeasy-group: "prompts" + x-speakeasy-name-override: "getOne" + operationId: "GetOnePrompt" + security: + - ApiKey: [] + summary: "Get one prompt" + parameters: + - schema: + type: "string" + description: "Prompt ID" + required: true + description: "Prompt ID" + name: "id" + in: "path" + responses: + "200": + description: "Prompt retrieved." + patch: + tags: + - "resources" + x-speakeasy-group: "prompts" + x-speakeasy-name-override: "update" + operationId: "UpdatePrompt" + security: + - ApiKey: [] + summary: "Update a prompt" + parameters: + - schema: + type: "string" + description: "Prompt ID" + required: true + description: "Prompt ID" + name: "id" + in: "path" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "display_name": + type: "string" + "domain_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "key": + type: "string" + responses: + "200": + description: "Prompt updated." + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + "404": + description: "Prompt not found." + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + "/v2/resources/prompts/{id}/duplicate": + get: + tags: + - "resources" + x-speakeasy-group: "prompts" + x-speakeasy-name-override: "duplicate" + operationId: "DuplicatePrompt" + security: + - ApiKey: [] + summary: "Duplicate a prompt" + parameters: + - schema: + type: "string" + description: "Prompt ID" + required: true + description: "Prompt ID" + name: "id" + in: "path" + responses: + "200": + description: "Prompt duplicated." + "/v2/resources/prompts/query": + post: + tags: + - "resources" + x-speakeasy-group: "prompts" + x-speakeasy-name-override: "getAll" + operationId: "GetAllPrompts" + security: + - ApiKey: [] + summary: "Get all prompts" + parameters: + - schema: + type: "string" + required: false + name: "page" + in: "query" + - schema: + type: "string" + required: false + name: "limit" + in: "query" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "filters": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "id" + "id": + type: "string" + "path": + type: "string" + required: + - "type" + - "id" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "search" + "value": + type: "string" + "searchPaths": + type: "array" + items: + type: "string" + required: + - "type" + - "value" + - "searchPaths" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "operator": + type: "string" + enum: + - "contains" + - "equals" + "value": + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "value" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "operator": + type: "string" + enum: + - "in" + "values": + type: "array" + items: + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "values" + - "path" + required: + - "filters" + responses: + "200": + description: "Prompts retrieved." + content: + "application/json": + schema: + type: "object" + properties: + "count": + type: "number" + "page": + type: "number" + "limit": + type: "number" + "totalPages": + type: "number" + "items": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + required: + - "count" + - "page" + - "limit" + - "totalPages" + - "items" + "/v2/resources/prompts/snippets/{key}": + get: + tags: + - "resources" + x-speakeasy-group: "prompt.snippets" + x-speakeasy-name-override: "findOne" + operationId: "FindOnePromptSnippet" + security: + - ApiKey: [] + summary: "Get one prompt snippet" + parameters: + - schema: + type: "string" + description: "Prompt Snippet Key" + required: true + description: "Prompt Snippet Key" + name: "key" + in: "path" + responses: + "200": + description: "Prompt snippet retrieved." + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + "400": + description: "Bad request." + "404": + description: "Prompt snippet not found." + "/v2/remoteconfigs": + post: + tags: + - "Remote Config" + x-speakeasy-name-override: "getConfig" + x-speakeasy-group: "remoteconfig" + operationId: "RemoteConfigsGetConfig" + summary: "Get Configurations" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "key": + type: "string" + description: "Remote configuration key" + "context": + type: "object" + additionalProperties: {} + description: "Key-value pairs matching your data model, applied to each prompt key." + "metadata": + type: "object" + additionalProperties: {} + description: "Key-value pairs to attach to the log generated by this request." + required: + - "key" + responses: + "200": + description: "An individual remote config" + content: + "application/json": + schema: + type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + - "string" + - "integer" + - "decimal" + - "list" + - "json" + - "deployment" + "value": {} + required: + - "type" + "400": + description: "Bad request" "401": - description: "Unauthorized." - "/v2/deployments/invoke": + description: "Unauthorized" + "404": + description: "Remote config not found" + "500": + description: "Internal server error" + "/v2/logs/query": post: - tags: - - "Deployments" - x-speakeasy-group: "deployments" - x-speakeasy-name-override: "invoke" - operationId: "DeploymentInvoke" - description: "Invoke a deployment with a given payload" - summary: "Invoke" + x-speakeasy-ignore: true requestBody: - required: true content: "application/json": - schema: {"$ref": "#/components/schemas/Deployments"} + schema: + type: "object" + properties: + "pagination": + type: "object" + properties: + "page": + type: "number" + "limit": + type: "number" + "lastId": + type: + - "string" + - "null" + required: + - "limit" + "sortingProps": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + description: "The path to sort by" + "direction": + type: "string" + enum: + - "asc" + - "desc" + description: "The direction to sort by" + required: + - "key" + "query": + type: "object" + properties: + "operator": + type: "string" + enum: + - "and" + - "or" + "filters": + type: "array" + items: + anyOf: + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + "value": {} + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "options": + type: "array" + items: + anyOf: + - type: "string" + - type: "number" + "optionsMap": + type: + - "object" + - "null" + additionalProperties: + anyOf: + - type: "string" + - type: "number" + "imageUrlMap": + type: "object" + additionalProperties: + type: "string" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "id" + - "type" + - "options" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + "value": + type: + - "array" + - "null" + items: {} + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "options": + type: "array" + items: + anyOf: + - type: "string" + - type: "number" + "optionsMap": + type: + - "object" + - "null" + additionalProperties: + anyOf: + - type: "string" + - type: "number" + "imageUrlMap": + type: "object" + additionalProperties: + type: "string" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "options" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + "value": + type: "object" + properties: + "criteria": + type: + - "object" + - "null" + properties: + "unit": + anyOf: + - type: "string" + enum: + - "day" + - "week" + - "month" + - "year" + - type: "string" + enum: + - "hours_ago" + - "minutes_ago" + "count": + type: + - "number" + - "null" + "relativeTime": + type: "string" + enum: + - "today" + - "yesterday" + - "one_week_ago" + - "one_month_ago" + - "custom_date" + "customDate": + type: + - "string" + - "null" + "direction": + type: "string" + enum: + - "present" + - "past" + "startDate": + type: + - "string" + - "null" + "endDate": + type: + - "string" + - "null" + "mode": + type: "string" + enum: + - "date" + - "datetime" + required: + - "criteria" + - "mode" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + "value": + anyOf: + - type: "number" + - type: "array" + items: + type: "number" + - type: "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "name" + - "path" + - type: "object" + properties: + "operator": + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + "value": + anyOf: + - {} + - type: "null" + - type: "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "options": + type: "array" + items: + allOf: + - type: "object" + properties: + "name": + type: "string" + "path": + type: "string" + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "name" + - "path" + - "type" + - type: "object" + properties: + "id": + type: "string" + required: + - "id" + "selectedOptionId": + type: + - "string" + - "null" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "id" + - "type" + - "options" + - "selectedOptionId" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + "value": + type: "boolean" + default: false + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "id" + - "type" + - "name" + - "path" + default: [] + required: + - "operator" + "filters": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "id" + "id": + type: "string" + "path": + type: "string" + required: + - "type" + - "id" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "search" + "value": + type: "string" + "searchPaths": + type: "array" + items: + type: "string" + required: + - "type" + - "value" + - "searchPaths" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "operator": + type: "string" + enum: + - "contains" + - "equals" + "value": + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "value" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "operator": + type: "string" + enum: + - "in" + "values": + type: "array" + items: + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "values" + - "path" + "includedFields": + type: "object" + additionalProperties: + type: "string" + required: + - "filters" responses: "200": - description: "Successful operation" + description: "Returns a list of workflow runs" + content: + "application/json": + schema: + type: "object" + properties: + "count": + type: "number" + description: "Total number of items" + readOnly: true + "items": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "remoteconfigs" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig" + "remote_config_id": + type: "string" + required: + - "type" + - "remote_config_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig_variant" + "remote_config_variant_id": + type: "string" + required: + - "type" + - "remote_config_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + "data": + type: "object" + properties: + "remote_config_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_key": + type: "string" + "remote_config_type": + type: "string" + "remote_config_version": + type: "number" + "remote_config_variant_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_variant_position": + type: "number" + "remote_config_value": {} + "is_default_matched": + type: "boolean" + "action": + type: "string" + enum: + - "get_config" + - "simulate" + required: + - "remote_config_id" + - "remote_config_key" + - "remote_config_type" + - "remote_config_version" + - "remote_config_variant_id" + - "remote_config_variant_position" + - "is_default_matched" + - "action" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for a remote config workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "deployments" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_key" + "deployment_key": + type: "string" + required: + - "type" + - "deployment_key" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment" + "deployment_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_variant" + "deployment_variant_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_completion" + "deployment_completion_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "chain" + "chain_id": + type: "string" + required: + - "type" + - "chain_id" + description: "Define the relationship between multiple logs that are part of the same chain" + - type: "object" + properties: + "type": + type: "string" + enum: + - "conversation" + "conversation_id": + type: "string" + required: + - "type" + - "conversation_id" + description: "Define the relationship between multiple logs that are part of the same conversation" + "data": + type: "object" + properties: + "deployment_id": + type: "string" + "deployment_key": + type: "string" + "deployment_variant_version": + type: "string" + "deployment_variant_position": + type: "number" + "deployment_variant_id": + type: "string" + format: "uuid" + "is_default_matched": + type: "boolean" + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "get_config" + - "invoke" + - "simulate" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "retries": + type: "array" + items: + type: "object" + properties: + "retry_attempt": + type: "number" + "status": + type: "number" + "message": + type: "string" + "is_fallback": + type: "boolean" + required: + - "retry_attempt" + - "status" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "metadata": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "settings": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "processing_attempts": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "started_at": + type: "string" + "queued_at": + type: "string" + "completed_at": + type: "string" + "errors": + type: "array" + items: + type: "object" + properties: + "code": + type: "number" + "message": + type: "string" + required: + - "code" + - "message" + required: + - "id" + - "started_at" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + "files": + type: "array" + items: + type: "object" + properties: + "file_id": + type: "string" + "file_name": + type: "string" + "object_name": + type: "string" + "content": + type: "string" + required: + - "file_id" + - "file_name" + - "object_name" + - "content" + "cache_key": + type: "string" + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + "is_caching_enabled": + type: "boolean" + "cache_status": + type: "string" + enum: + - "HIT" + - "MISS" + required: + - "deployment_id" + - "deployment_key" + - "deployment_variant_version" + - "deployment_variant_position" + - "deployment_variant_id" + - "is_default_matched" + - "action" + - "prompt_config" + - "variables" + - "retries" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "playgrounds" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground" + "playground_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_block" + "playground_block_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_block_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_completion" + "playground_completion_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "choices" + - "action" + - "prompt_config" + - "variables" + - "billing" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "experiments" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment" + "experiment_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "experiment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_run" + "experiment_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "experiment_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "test_case_run" + "test_case_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_test_case" + "test_case_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + default: "invoke" + "integration_ids": + type: "array" + items: + type: "string" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the experiment workflow run" + description: "The schema for a workflow run" + description: "List of items" + uniqueItems: true + "nextLastId": + type: + - "string" + - "null" + required: + - "count" + - "items" + "400": + description: "Bad request - validation error" content: "application/json": schema: type: "object" properties: - "id": - type: "string" - format: "ulid" - description: "A unique identifier for the response. Can be used to add metrics to the transaction." - readOnly: true - "created": - type: "string" - format: "date-time" - description: "A timestamp indicating when the object was created. Usually in a standardized format like ISO 8601" - "object": - type: "string" - enum: - - "chat" - - "completion" - - "image" - - "vision" - description: "Indicates the type of model used to generate the response" - "model": + "code": + type: "number" + description: "HTTP status code" + "error": type: "string" - description: "The model used to generate the response" - "provider": + description: "Error message" + "source": type: "string" enum: - - "cohere" - - "openai" - - "anthropic" - - "huggingface" - - "replicate" - - "google" - - "google-ai" - - "azure" - - "aws" - - "anyscale" - - "perplexity" - - "groq" - - "fal" - - "leonardoai" - - "nvidia" - - "jina" - description: "The provider used to generate the response" - "is_final": - type: "boolean" - description: "Indicates if the response is the final response" - "integration_id": - type: "string" - description: "Indicates integration id used to generate the response" - "finalized": + - "provider" + - "system" + description: "The source where the error came from" + required: + - "code" + - "error" + - "source" + "403": + description: "Authorization error" + content: + "application/json": + schema: + type: "object" + properties: + "message": type: "string" - format: "date-time" - description: "A timestamp indicating when the object was finalized. Usually in a standardized format like ISO 8601" - "system_fingerprint": - type: - - "string" - - "null" - description: "Provider backed system fingerprint." - "choices": - type: "array" - items: - type: "object" - properties: - "index": - type: "number" - "message": - anyOf: + required: + - "message" + "500": + description: "Internal server error" + content: + "application/json": + schema: + type: "object" + properties: + "code": + type: "number" + description: "HTTP status code" + "error": + type: "string" + description: "Error message" + "source": + type: "string" + enum: + - "provider" + - "system" + description: "The source where the error came from" + required: + - "code" + - "error" + - "source" + "/v2/logs/{id}": + get: + x-speakeasy-ignore: true + parameters: + - schema: + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: true + name: "id" + in: "path" + responses: + "200": + description: "Returns a single workflow run" + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "remoteconfigs" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig" + "remote_config_id": + type: "string" + required: + - "type" + - "remote_config_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig_variant" + "remote_config_variant_id": + type: "string" + required: + - "type" + - "remote_config_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + "data": + type: "object" + properties: + "remote_config_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_key": + type: "string" + "remote_config_type": + type: "string" + "remote_config_version": + type: "number" + "remote_config_variant_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_variant_position": + type: "number" + "remote_config_value": {} + "is_default_matched": + type: "boolean" + "action": + type: "string" + enum: + - "get_config" + - "simulate" + required: + - "remote_config_id" + - "remote_config_key" + - "remote_config_type" + - "remote_config_version" + - "remote_config_variant_id" + - "remote_config_variant_position" + - "is_default_matched" + - "action" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for a remote config workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "deployments" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_key" + "deployment_key": + type: "string" + required: + - "type" + - "deployment_key" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment" + "deployment_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_variant" + "deployment_variant_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_completion" + "deployment_completion_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "chain" + "chain_id": + type: "string" + required: + - "type" + - "chain_id" + description: "Define the relationship between multiple logs that are part of the same chain" + - type: "object" + properties: + "type": + type: "string" + enum: + - "conversation" + "conversation_id": + type: "string" + required: + - "type" + - "conversation_id" + description: "Define the relationship between multiple logs that are part of the same conversation" + "data": + type: "object" + properties: + "deployment_id": + type: "string" + "deployment_key": + type: "string" + "deployment_variant_version": + type: "string" + "deployment_variant_position": + type: "number" + "deployment_variant_id": + type: "string" + format: "uuid" + "is_default_matched": + type: "boolean" + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "get_config" + - "invoke" + - "simulate" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "retries": + type: "array" + items: + type: "object" + properties: + "retry_attempt": + type: "number" + "status": + type: "number" + "message": + type: "string" + "is_fallback": + type: "boolean" + required: + - "retry_attempt" + - "status" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "metadata": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "settings": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "processing_attempts": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "started_at": + type: "string" + "queued_at": + type: "string" + "completed_at": + type: "string" + "errors": + type: "array" + items: + type: "object" + properties: + "code": + type: "number" + "message": + type: "string" + required: + - "code" + - "message" + required: + - "id" + - "started_at" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + "files": + type: "array" + items: + type: "object" + properties: + "file_id": + type: "string" + "file_name": + type: "string" + "object_name": + type: "string" + "content": + type: "string" + required: + - "file_id" + - "file_name" + - "object_name" + - "content" + "cache_key": + type: "string" + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + "is_caching_enabled": + type: "boolean" + "cache_status": + type: "string" + enum: + - "HIT" + - "MISS" + required: + - "deployment_id" + - "deployment_key" + - "deployment_variant_version" + - "deployment_variant_position" + - "deployment_variant_id" + - "is_default_matched" + - "action" + - "prompt_config" + - "variables" + - "retries" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "playgrounds" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground" + "playground_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_block" + "playground_block_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_block_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_completion" + "playground_completion_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "choices" + - "action" + - "prompt_config" + - "variables" + - "billing" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" - type: "object" properties: - "role": + "type": type: "string" enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": + - "boolean" + "value": type: - - "string" + - "boolean" - "null" - "tool_calls": + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": type: "array" items: - type: "object" - properties: - "id": - type: "string" - "index": - type: "number" - "type": - type: "string" - enum: - - "function" - "function": - type: "object" + oneOf: + - type: "object" properties: - "name": + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": type: "string" - "arguments": + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": type: "string" - description: "JSON string arguments for the functions" required: - - "name" - - "arguments" - required: - - "type" - - "function" - required: - - "role" - - "tool_calls" - - type: "object" - properties: - "role": + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": type: "string" enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - type: - - "string" - - "null" + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" required: - - "role" - - "content" + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" - type: "object" properties: - "role": + "type": type: "string" enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "url": - type: "string" - required: - - "role" - - "url" - "finish_reason": - type: - - "string" - - "null" - required: - - "index" - description: "A list of choices generated by the model" - "retrievals": - type: "array" - items: - type: "object" - properties: - "document": - type: "string" - description: "Content of the retrieved chunk from the knowledge base" - "metadata": - type: "object" - properties: - "file_name": - type: "string" - description: "Name of the file" - "page_number": - type: - - "number" - - "null" - description: "Page number of the chunk" - "file_type": - type: "string" - description: "Type of the file" - "rerank_score": - type: "number" - description: "Rerank scores are normalized to be in the range [0, 1]. Scores close to 1 indicate a high relevance to the query, and scores closer to 0 indicate low relevance. It is not accurate to assume a score of 0.9 means the document is 2x more relevant than a document with a score of 0.45" - "search_score": - type: "number" - description: "Search scores are normalized to be in the range [0, 1]. Search score is calculated based on `[Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity)` algorithm. Scores close to 1 indicate the document is closer to the query, and scores closer to 0 indicate the document is farther from the query." - required: - - "file_name" - - "page_number" - - "file_type" - - "search_score" - description: "Metadata of the retrieved chunk from the knowledge base" - required: - - "document" - - "metadata" - description: "List of documents retrieved from the knowledge base. This property is only available when the `include_retrievals` flag is set to `true` in the invoke settings. When stream is set to true, the `retrievals` property will be returned in the last streamed chunk where the property `is_final` is set to `true`." - "provider_response": - description: "Response returned by the model provider. This functionality is only supported when streaming is not used. If streaming is used, the `provider_response` property will be set to `null`." - required: - - "id" - - "created" - - "object" - - "model" - - "provider" - - "is_final" - - "choices" - description: "Response from the gateway" - "text/event-stream": - schema: - type: "object" - properties: - "data": - type: "object" - properties: - "id": - type: "string" - format: "ulid" - description: "A unique identifier for the response. Can be used to add metrics to the transaction." - readOnly: true - "created": - type: "string" - format: "date-time" - description: "A timestamp indicating when the object was created. Usually in a standardized format like ISO 8601" - "object": - type: "string" - enum: - - "chat" - - "completion" - - "image" - description: "Indicates the type of model used to generate the response" - "model": - type: "string" - description: "The model used to generate the response" - "provider": - type: "string" - enum: - - "cohere" - - "openai" - - "anthropic" - - "huggingface" - - "replicate" - - "google" - - "google-ai" - - "azure" - - "aws" - - "anyscale" - - "perplexity" - - "groq" - - "fal" - - "leonardoai" - - "nvidia" - description: "The provider used to generate the response" - "is_final": - type: "boolean" - description: "Indicates if the response is the final response" - "integration_id": - type: "string" - description: "Indicates integration id used to generate the response" - "finalized": - type: "string" - format: "date-time" - description: "A timestamp indicating when the object was finalized. Usually in a standardized format like ISO 8601" - "system_fingerprint": - type: - - "string" - - "null" - description: "Provider backed system fingerprint." - "choices": - type: "array" - items: - type: "object" - properties: - "index": - type: "number" - "message": - anyOf: - - type: "object" + - "llm_eval" + "workflow_run": + type: "object" properties: - "role": + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": type: "string" enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - type: - - "string" - - "null" - "tool_calls": + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": type: "array" items: - type: "object" - properties: - "id": - type: "string" - "index": - type: "number" - "type": - type: "string" - enum: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" - "function" - "function": + "prompt_snippets": + type: "array" + items: type: "object" properties: - "name": + "_id": type: "string" - "arguments": + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": type: "string" - description: "JSON string arguments for the functions" required: - - "name" - - "arguments" + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true required: - "type" - - "function" - required: - - "role" - - "tool_calls" - - type: "object" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" properties: - "role": + "workflow_run_id": type: "string" - enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": type: - "string" - "null" required: - - "role" - - "content" - - type: "object" - properties: - "role": - type: "string" - enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "url": - type: "string" - required: - - "role" - - "url" - "finish_reason": - type: - - "string" - - "null" - required: - - "index" - description: "A list of choices generated by the model" - "retrievals": + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "experiments" + "related_entities": type: "array" items: - type: "object" - properties: - "document": - type: "string" - description: "Content of the retrieved chunk from the knowledge base" - "metadata": - type: "object" + oneOf: + - type: "object" properties: - "file_name": + "type": type: "string" - description: "Name of the file" - "page_number": - type: - - "number" - - "null" - description: "Page number of the chunk" - "file_type": + enum: + - "experiment" + "experiment_id": type: "string" - description: "Type of the file" - "rerank_score": - type: "number" - description: "Rerank scores are normalized to be in the range [0, 1]. Scores close to 1 indicate a high relevance to the query, and scores closer to 0 indicate low relevance. It is not accurate to assume a score of 0.9 means the document is 2x more relevant than a document with a score of 0.45" - "search_score": - type: "number" - description: "Search scores are normalized to be in the range [0, 1]. Search score is calculated based on `[Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity)` algorithm. Scores close to 1 indicate the document is closer to the query, and scores closer to 0 indicate the document is farther from the query." + format: "uuid" + description: "The id of the resource" + readOnly: true required: - - "file_name" - - "page_number" - - "file_type" - - "search_score" - description: "Metadata of the retrieved chunk from the knowledge base" - required: - - "document" - - "metadata" - description: "List of documents retrieved from the knowledge base. This property is only available when the `include_retrievals` flag is set to `true` in the invoke settings. When stream is set to true, the `retrievals` property will be returned in the last streamed chunk where the property `is_final` is set to `true`." - "provider_response": - description: "Response returned by the model provider. This functionality is only supported when streaming is not used. If streaming is used, the `provider_response` property will be set to `null`." - required: - - "id" - - "created" - - "object" - - "model" - - "provider" - - "is_final" - - "choices" - description: "Response from the gateway" - x-speakeasy-sse-sentinel: "[DONE]" - "204": - description: "No content - successful operation" - "/v2/deployments/{id}/metrics": - post: - tags: - - "Deployments" - x-speakeasy-group: "deployments.metrics" - x-speakeasy-name-override: "create" - operationId: "DeploymentCreateMetric" - description: "Add metrics to a deployment" - summary: "Add metrics" - parameters: - - schema: - type: "string" - description: "Deployment ID" - required: true - description: "Deployment ID" - name: "id" - in: "path" - requestBody: - required: true - description: "The deployment request payload" - content: - "application/json": - schema: - type: "object" - properties: - "metadata": - type: "object" - additionalProperties: {} - description: "Your own custom key-value pairs can be attached to the logs. This is useful for storing additional information related to your interactions with the LLM providers or specifics within your application." - "usage": - type: "object" - properties: - "prompt_tokens": - type: "number" - description: "Number of tokens in the prompt." - "completion_tokens": - type: "number" - description: "Number of tokens in the generated completion." - "total_tokens": - type: "number" - description: "Total number of tokens used in the request (prompt + completion)." - required: - - "prompt_tokens" - - "completion_tokens" - description: "Usage statistics to add to the deployment" - "performance": - type: "object" - properties: - "latency": - type: "number" - description: "Total time in milliseconds of the request to the LLM provider API." - "time_to_first_token": - type: "number" - description: "Total time in milliseconds to generate the first token of the completion." - required: - - "latency" - "messages": - type: "array" - items: - type: "object" - properties: - "role": - type: "string" - enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - anyOf: - - type: "string" - - type: "array" + - "type" + - "experiment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_run" + "experiment_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "experiment_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "test_case_run" + "test_case_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_test_case" + "test_case_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" items: - oneOf: - - type: "object" - properties: - "type": - type: "string" - enum: - - "text" - "text": - type: "string" - required: - - "type" - - "text" - description: "Text content part of a prompt message" - - type: "object" - properties: - "type": - type: "string" - enum: - - "image_url" - "image_url": - type: "object" + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" properties: - "id": + "role": type: "string" - format: "ulid" - description: "The orq.ai id of the image" - readOnly: true + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" "url": - anyOf: - - type: "string" - - type: "string" - format: "uri" - description: "Either a URL of the image or the base64 encoded data URI." - examples: - - "https://picsum.photos/id/1/200/300" - - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" - "detail": type: "string" - description: "Specifies the detail level of the image. Currently only supported with OpenAI models" required: + - "role" - "url" - required: - - "type" - - "image_url" - description: "The image part of the prompt message. Only supported with vision models." - description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " - "tool_calls": - type: "array" - items: - type: "object" - properties: - "id": - type: "string" - "index": - type: "number" - "type": - type: "string" - enum: - - "function" - "function": - type: "object" - properties: - "name": - type: "string" - "arguments": - type: "string" - description: "JSON string arguments for the functions" + "finish_reason": + type: + - "string" + - "null" required: - - "name" - - "arguments" - required: - - "type" - - "function" - required: - - "role" - - "content" - description: "A list of messages sent to the model." - "choices": - type: "array" - items: - type: "object" - properties: - "index": - type: "number" - "message": - anyOf: - - type: "object" + - "index" + "action": + type: "string" + enum: + - "invoke" + default: "invoke" + "integration_ids": + type: "array" + items: + type: "string" + "prompt_config": + type: "object" properties: - "role": + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": type: "string" enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - type: - - "string" - - "null" - "tool_calls": + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": type: "array" items: type: "object" properties: - "id": - type: "string" - "index": - type: "number" - "type": + "role": type: "string" enum: - - "function" - "function": - type: "object" - properties: - "name": - type: "string" - "arguments": - type: "string" - description: "JSON string arguments for the functions" - required: - - "name" - - "arguments" + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true required: - - "type" - - "function" + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" required: - - "role" - - "tool_calls" - - type: "object" + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" properties: - "role": - type: "string" - enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": + "latency": + type: "number" + "first_time_to_token": type: - - "string" + - "number" + - "null" + "tokens_per_second": + type: + - "number" - "null" required: - - "role" - - "content" - - type: "object" + - "latency" + "usage": + type: "object" properties: - "role": - type: "string" - enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "url": - type: "string" + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" required: - - "role" - - "url" - "finish_reason": - type: - - "string" - - "null" + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "prompt_config" + - "variables" + - "prompt_snippets" required: - - "index" - description: "A list of completion choices. If you are using a `completion` model then you must provide the `completion content` with the chat completion format" - "feedback": - type: "object" - properties: - "score": - type: "integer" - minimum: 0 - maximum: 100 - description: "The feedback score. This allow you to come with specific logic on what a `score` number means" - required: - - "score" - description: "Feedback from the user on the completion" - responses: - "200": - description: "Successful operation" + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the experiment workflow run" + description: "The schema for a workflow run" + "400": + description: "Bad request - validation error" content: "application/json": schema: @@ -5088,200 +77901,63 @@ paths: properties: "code": type: "number" - description: "The status code of the request" - "success": - type: "boolean" - description: "Whether the request was successful" + description: "HTTP status code" + "error": + type: "string" + description: "Error message" + "source": + type: "string" + enum: + - "provider" + - "system" + description: "The source where the error came from" required: - "code" - - "success" - "400": - description: "Bad Request" - "401": - description: "Unauthorized." - "/v2/files": - post: - tags: - - "Files" - x-speakeasy-group: "files" - x-speakeasy-name-override: "upload" - operationId: "FileUpload" - summary: "Upload file" - description: "Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config)." - requestBody: - required: true - content: - "multipart/form-data": - schema: - type: "object" - properties: - "file": - type: "string" - description: "The file to be uploaded." - format: "binary" - "purpose": - type: "string" - enum: - - "retrieval" - default: "retrieval" - description: "The intended purpose of the uploaded file." - responses: - "200": - description: "File uploaded successfully" + - "error" + - "source" + "403": + description: "Authorization error" content: "application/json": schema: type: "object" properties: - "_id": - type: "string" - "object_name": - type: "string" - description: "path to the file in the storage" - "purpose": - type: "string" - enum: - - "retrieval" - description: "The intended purpose of the uploaded file." - "bytes": - type: "number" - "file_name": - type: "string" - "created": + "message": type: "string" - format: "date-time" - default: "2024-12-16T16:28:54.131Z" - description: "The date and time the resource was created" - readOnly: true required: - - "_id" - - "object_name" - - "purpose" - - "bytes" - - "file_name" - "400": - description: "Bad request" - "/v2/files/bulk": - post: - tags: - - "Files" - x-speakeasy-group: "files" - x-speakeasy-name-override: "bulkUpload" - operationId: "BulkFileUpload" - summary: "Bulk upload file" - description: "Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config)." - requestBody: - required: true - content: - "multipart/form-data": - schema: - type: "object" - properties: - "files": - type: "array" - items: - type: "string" - description: "The file to be uploaded." - format: "binary" - "purpose": - type: "string" - enum: - - "retrieval" - description: "The intended purpose of the uploaded file." - required: - - "files" - - "purpose" - responses: - "200": - description: "Bulk files uploaded successfully" + - "message" + "404": + description: "Workspace ID is not found on the request" content: "application/json": schema: - type: "array" - items: - type: "object" - properties: - "_id": - type: "string" - "object_name": - type: "string" - description: "path to the file in the storage" - "purpose": - type: "string" - enum: - - "retrieval" - description: "The intended purpose of the uploaded file." - "bytes": - type: "number" - "file_name": - type: "string" - "created": - type: "string" - format: "date-time" - default: "2024-12-16T16:28:54.131Z" - description: "The date and time the resource was created" - readOnly: true - required: - - "_id" - - "object_name" - - "purpose" - - "bytes" - - "file_name" - "400": - description: "Bad request" - "/v2/remoteconfigs": - post: - tags: - - "Remote Config" - x-speakeasy-name-override: "getConfig" - x-speakeasy-group: "remoteconfig" - operationId: "RemoteConfigsGetConfig" - summary: "Get Configurations" - requestBody: - content: - "application/json": - schema: - type: "object" - properties: - "key": - type: "string" - description: "Remote configuration key" - "context": - type: "object" - additionalProperties: {} - description: "Key-value pairs matching your data model, applied to each prompt key." - "metadata": - type: "object" - additionalProperties: {} - description: "Key-value pairs to attach to the log generated by this request." - required: - - "key" - responses: - "200": - description: "An individual remote config" + type: "object" + properties: + "message": + type: "string" + required: + - "message" + description: "Error message" + "500": + description: "Internal server error" content: "application/json": schema: type: "object" properties: - "type": + "code": + type: "number" + description: "HTTP status code" + "error": + type: "string" + description: "Error message" + "source": type: "string" enum: - - "boolean" - - "string" - - "integer" - - "decimal" - - "list" - - "json" - - "deployment" - "value": {} + - "provider" + - "system" + description: "The source where the error came from" required: - - "type" - "400": - description: "Bad request" - "401": - description: "Unauthorized" - "404": - description: "Remote config not found" - "500": - description: "Internal server error" + - "code" + - "error" + - "source" diff --git a/openapi.yaml b/openapi.yaml index a5ce8ee..50e04f5 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1153,7 +1153,6 @@ components: - "chat" - "completion" - "image" - - "vision" description: "Indicates the type of model used to generate the response" "model": type: "string" @@ -2878,7 +2877,7 @@ components: "created": type: "string" format: "date-time" - default: "2024-12-16T16:28:54.131Z" + default: "2024-12-01T21:30:45.101Z" description: "The date and time the resource was created" readOnly: true required: @@ -2922,7 +2921,7 @@ components: "created": type: "string" format: "date-time" - default: "2024-12-16T16:28:54.131Z" + default: "2024-12-01T21:30:45.101Z" description: "The date and time the resource was created" readOnly: true required: @@ -2948,72 +2947,416 @@ components: required: - "files" - "purpose" - "GetRemoteConfigRequest": + "DatasetCreateRequest": type: "object" properties: - "key": + "display_name": type: "string" - description: "Remote configuration key" - "context": - type: "object" - additionalProperties: {} - description: "Key-value pairs matching your data model, applied to each prompt key." - "metadata": - type: "object" - additionalProperties: {} - description: "Key-value pairs to attach to the log generated by this request." + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" required: - - "key" - "GetRemoteConfigResponse": + - "display_name" + - "domain_id" + "DatasetDeleteRequest": type: "object" properties: - "type": + "dataset_id": type: "string" - enum: - - "boolean" - - "string" - - "integer" - - "decimal" - - "list" - - "json" - - "deployment" - "value": {} + description: "Dataset ID" required: - - "type" - "HonoApiError": + - "dataset_id" + "DatasetGetOneRequest": type: "object" properties: - "code": + "dataset_id": type: "string" - description: "HTTP status code" - "message": + description: "Dataset ID" + required: + - "dataset_id" + "DatasetUpdateRequest": + type: "object" + properties: + "display_name": type: "string" - description: "Error message" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + "DatasetCreateResponse": + type: "object" + properties: + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" required: - - "message" - "Deployments": + - "display_name" + - "domain_id" + "DatasetGetOneResponse": + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + "updated_by": + type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "email": + type: "string" + format: "email" + description: "Email of the user" + "display_name": + type: "string" + description: "Display name of the user" + "logo_url": + type: + - "string" + - "null" + format: "uri" + description: "URL of the user logo" + required: + - "id" + - "email" + - "display_name" + - "logo_url" + description: "User model returned from the API" + "updated_by_id": + type: + - "string" + - "null" + format: "uuid" + description: "The user who last updated the dataset" + "items": + type: "array" + items: + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset row model from the API." + required: + - "id" + - "display_name" + - "domain_id" + - "updated_by" + - "updated_by_id" + - "items" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset model from the API" + "DatasetUpdateResponse": type: "object" properties: - "key": + "display_name": type: "string" - description: "The deployment id to invoke" - "stream": - type: "boolean" - default: false - description: "If set, partial message content will be sent. Tokens will be sent as data-only `server-sent events` as they become available, with the stream terminated by a `data: [DONE]` message." - "inputs": - type: "object" - additionalProperties: - anyOf: - - type: "string" - - type: "number" - - type: "boolean" - description: "Key-value pairs variables to replace in your prompts. If a variable is not provided that is defined in the prompt, the default variables are used." - "context": - type: "object" - additionalProperties: {} - description: "Key-value pairs that match your data model and fields declared in your configuration matrix. If you send multiple prompt keys, the context will be applied to the evaluation of each key." - "prefix_messages": + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + "DatasetRowPostBulkRequest": + type: "object" + properties: + "datasetRows": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + description: "Expected dataset row model when talking to the API." + example: {"id": "uuid-string", "messages": [{"role": "assistant", "content": "You are a helpful assistant.", "tool_calls": [{"id": "tool-id", "index": 0, "type": "function", "function": {"name": "some-function", "arguments": "some-args"}}]}]} + required: + - "datasetRows" + "DatasetRowPostRequest": + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "messages": type: "array" items: type: "object" @@ -3111,7 +3454,39 @@ components: required: - "role" - "content" - description: "A list of messages to include after the `System` message, but before the `User` and `Assistant` pairs configured in your deployment." + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + "DatasetIdParamRequest": + type: "object" + properties: + "dataset_id": + type: "string" + description: "Dataset ID" + required: + - "dataset_id" + "DatasetRowIdParamRequest": + type: "object" + properties: + "row_id": + type: "string" + description: "Dataset row ID" + required: + - "row_id" + "DatasetRowPostResponse": + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true "messages": type: "array" items: @@ -3210,556 +3585,998 @@ components: required: - "role" - "content" - description: "A list of messages to send to the deployment." - "file_ids": - type: "array" - items: - type: "string" - description: "A list of file IDs that are associated with the deployment request." - "metadata": - type: "object" - additionalProperties: {} - description: "Key-value pairs that you want to attach to the log generated by this request." - "chain_id": - type: "string" - description: "Unique ID that identifies a chaining operation. This is useful for tracking a chain of completions across multiple " - "conversation_id": - type: "string" - description: "Unique ID that identifies a chat conversation. This is useful for tracking the same conversation across multiple requests" - "user_id": - anyOf: - - type: "string" - - type: "number" - description: "Unique ID that identifies a user. This is useful for tracking the same user across multiple requests" - "deployment_id": - type: "string" - description: "Unique ID that identifies a deployment entity." - "deployment_variant_id": - type: "string" - description: "Unique ID that identifies a specific variant of a deployment." - "extra_params": - type: "object" - additionalProperties: {} - description: "Utilized for passing additional parameters to the model provider. Exercise caution when using this feature, as the included parameters will overwrite any parameters specified in the deployment prompt configuration." - "invoke_options": - type: "object" - properties: - "include_retrievals": - type: "boolean" - default: false - description: "Whether to include the retrieved knowledge chunks in the response." + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" required: - - "key" - description: "The deployment request payload" -paths: - "/v2/contacts": - post: - tags: - - "Contacts" - x-speakeasy-name-override: "create" - operationId: "CreateContact" - description: "Update or add user information to workspace" - summary: "Update user information" - requestBody: - required: true - description: "Update user information payload" - content: - "application/json": - schema: - type: "object" - properties: - "external_id": - type: "string" - minLength: 1 - description: "Unique string value to identify the contact user in the customer's system" - "display_name": - type: - - "string" - - "null" - description: "Display name or nickname of the user" - "email": - type: - - "string" - - "null" - format: "email" - description: "Email address of the user" - "avatar_url": - type: - - "string" - - "null" - description: "URL linking to the user's avatar image" - "tags": - type: "array" - items: - type: "string" - format: "uuid" - description: "Array of UUIDs representing tags associated with the user" - "metadata": - type: "object" - additionalProperties: {} - description: "Additional custom metadata associated with the user as key-value pairs" - required: - - "external_id" - responses: - "200": - description: "Successful operation" - content: - "application/json": - schema: - type: "object" - properties: - "id": - type: "string" - description: "Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the user" - "external_id": - type: "string" - minLength: 1 - description: "Unique string value to identify the contact user in the customer's system" - "display_name": - type: - - "string" - - "null" - description: "Display name or nickname of the user" - "email": - type: - - "string" - - "null" - format: "email" - description: "Email address of the user" - "avatar_url": - type: - - "string" - - "null" - description: "URL linking to the user's avatar image" - "tags": - type: "array" - items: - type: "string" - format: "uuid" - description: "Array of UUIDs representing tags associated with the user" - "metadata": - type: "object" - additionalProperties: {} - description: "Additional custom metadata associated with the user as key-value pairs" - "created": - anyOf: - - type: "string" - format: "date-time" - - type: "string" - default: "2024-12-16T16:28:53.855Z" - description: "The date and time the resource was created" - readOnly: true - format: "date-time" - "updated": - anyOf: - - type: "string" - format: "date-time" - default: "2024-12-16T16:28:53.856Z" - - type: "string" - description: "The date and time the resource was last updated" - readOnly: true - format: "date-time" - required: - - "id" - - "external_id" - "/v2/feedback": - post: - tags: - - "Feedback" - x-speakeasy-name-override: "create" - operationId: "CreateFeedback" - description: "Submit feedback for the LLM transaction via the API" - summary: "Submit feedback" - requestBody: - required: true - description: "Feedback submission payload" - content: - "application/json": - schema: - type: "object" - properties: - "property": - type: "string" - description: "A string describing the specific property or aspect rated." - x-speakeasy-name-override: "field" - "value": - anyOf: - - type: "string" - - type: "array" - items: - type: "string" - description: "The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string." - "trace_id": - type: "string" - description: "The id returned by the [`get_config`]() or [`invoke`](https://docs.orq.ai/reference/post_deployments-invoke-1) endpoints" - required: - - "property" - - "value" - - "trace_id" - example: {"value": ["good"], "property": "rating", "trace_id": "67HTZ65Z9W91HSF51CW68KK1QH"} - responses: - "200": - description: "Successful operation" - content: - "application/json": - schema: + - "id" + - "messages" + "DatasetRowGetResponse": + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "messages": + type: "array" + items: type: "object" properties: - "property": + "role": type: "string" - description: "A string describing the specific property or aspect rated." - "value": + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": anyOf: - type: "string" - type: "array" items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": type: "string" - description: "The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string." - "trace_id": - type: "string" - description: "The id returned by the [`get_config`]() or [`invoke`](https://docs.orq.ai/reference/post_deployments-invoke-1) endpoints" - "id": - type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" required: - - "property" - - "value" - - "trace_id" - - "id" - "/v2/deployments": - get: - tags: - - "Deployments" - x-speakeasy-group: "deployments" - x-speakeasy-name-override: "all" - operationId: "Deployments" - description: "Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first." - summary: "List all deployments" - parameters: - - schema: - type: "number" - minimum: 1 - maximum: 50 - default: 10 - description: "A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10" - required: false - description: "A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10" - name: "limit" - in: "query" - - schema: - type: "string" - description: "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `ed33dade-ae32-4959-8c5c-7ae4aad748b5`, your subsequent call can include `after=ed33dade-ae32-4959-8c5c-7ae4aad748b5` in order to fetch the next page of the list." - required: false - description: "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `ed33dade-ae32-4959-8c5c-7ae4aad748b5`, your subsequent call can include `after=ed33dade-ae32-4959-8c5c-7ae4aad748b5` in order to fetch the next page of the list." - name: "after" - in: "query" - responses: - "200": - description: "List of deployments" - content: - "application/json": - schema: - type: "object" + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset row model from the API." + "DatasetRowErrorResponse": + type: "object" + properties: + "message": + type: "string" + required: + - "message" + "DatasetRowPaginatedGetResponse": + type: "object" + properties: + "count": + type: "number" + "page": + type: "number" + "limit": + type: "number" + "totalPages": + type: "number" + "items": + type: "array" + items: + allOf: + - type: "object" properties: - "object": + "id": type: "string" - enum: - - "list" - "data": + format: "uuid" + readOnly: true + "messages": type: "array" items: type: "object" properties: - "id": - type: "string" - format: "uuid" - description: "Unique identifier for the object." - "created": - type: "string" - description: "Date in ISO 8601 format at which the object was created." - "updated": - type: "string" - description: "Date in ISO 8601 format at which the object was last updated." - "key": - type: "string" - description: "The deployment unique key" - "description": + "role": type: "string" - description: "An arbitrary string attached to the object. Often useful for displaying to users." - "prompt_config": - type: "object" - properties: - "tools": - type: "array" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" items: - allOf: + oneOf: - type: "object" properties: "type": type: "string" enum: - - "function" - description: "The type of the tool. Currently, only `function` is supported." - "function": + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": type: "object" properties: - "name": + "id": type: "string" - description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." - "description": + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": type: "string" - description: "A description of what the function does, used by the model to choose when and how to call the function." - "strict": - type: "boolean" - "parameters": - type: "object" - properties: - "type": - type: "string" - enum: - - "object" - "properties": - type: "object" - additionalProperties: {} - "required": - type: "array" - items: - type: "string" - "additionalProperties": - type: "boolean" - enum: - - false - required: - - "type" - - "properties" - description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" required: - - "name" - - "parameters" + - "url" required: - "type" - - "function" - - type: "object" - properties: - "id": - type: "number" - "model": + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset row model from the API." + required: + - "count" + - "page" + - "limit" + - "totalPages" + - "items" + "DatasetRowPatchResponse": + type: "object" + properties: + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": type: "string" - "model_type": + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": type: "string" enum: - - "chat" - - "completion" - - "embedding" - - "vision" - - "image" - - "tts" - - "stt" - - "rerank" - - "moderations" - description: "The type of the model" - "model_parameters": + - "image_url" + "image_url": type: "object" properties: - "temperature": - type: "number" - description: "Only supported on `chat` and `completion` models." - "maxTokens": - type: "number" - description: "Only supported on `chat` and `completion` models." - "topK": - type: "number" - description: "Only supported on `chat` and `completion` models." - "topP": - type: "number" - description: "Only supported on `chat` and `completion` models." - "frequencyPenalty": - type: "number" - description: "Only supported on `chat` and `completion` models." - "presencePenalty": - type: "number" - description: "Only supported on `chat` and `completion` models." - "numImages": - type: "number" - description: "Only supported on `image` models." - "seed": - type: "number" - description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" - "format": - type: "string" - enum: - - "url" - - "b64_json" - - "text" - - "json_object" - description: "Only supported on `image` models." - "dimensions": - type: "string" - description: "Only supported on `image` models." - "quality": - type: "string" - enum: - - "standard" - - "hd" - description: "Only supported on `image` models." - "style": - type: "string" - description: "Only supported on `image` models." - "responseFormat": - oneOf: - - type: "object" - properties: - "type": - type: "string" - enum: - - "json_schema" - "json_schema": - type: "object" - properties: - "name": - type: "string" - "strict": - type: "boolean" - "schema": - type: "object" - additionalProperties: {} - required: - - "name" - - "strict" - - "schema" - required: - - "type" - - "json_schema" - - type: "object" - properties: - "type": - type: "string" - enum: - - "json_object" - required: - - "type" - - type: "null" - description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." - "photoRealVersion": + "id": type: "string" - enum: - - "v1" - - "v2" - description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" - "encoding_format": + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": type: "string" - enum: - - "float" - - "base64" - description: "The format to return the embeddings" - description: "Model Parameters: Not all parameters apply to every model" - "provider": - type: "string" - enum: - - "cohere" - - "openai" - - "anthropic" - - "huggingface" - - "replicate" - - "google" - - "google-ai" - - "azure" - - "aws" - - "anyscale" - - "perplexity" - - "groq" - - "fal" - - "leonardoai" - - "nvidia" - - "jina" - "messages": - type: "array" - items: - type: "object" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "messages" + "PromptTemplateGetAllRequest": + type: "object" + properties: + "page": + type: "string" + "limit": + type: "string" + "PromptTemplateGetAllResponse": + type: "object" + properties: + "count": + type: "number" + "items": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" properties: - "role": + "type": type: "string" enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - anyOf: - - type: "string" - - type: "array" - items: - oneOf: - - type: "object" - properties: - "type": - type: "string" - enum: - - "text" - "text": - type: "string" - required: - - "type" - - "text" - description: "Text content part of a prompt message" - - type: "object" - properties: - "type": - type: "string" - enum: - - "image_url" - "image_url": - type: "object" - properties: - "id": - type: "string" - format: "ulid" - description: "The orq.ai id of the image" - readOnly: true - "url": - anyOf: - - type: "string" - - type: "string" - format: "uri" - description: "Either a URL of the image or the base64 encoded data URI." - examples: - - "https://picsum.photos/id/1/200/300" - - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" - "detail": - type: "string" - description: "Specifies the detail level of the image. Currently only supported with OpenAI models" - required: - - "url" - required: - - "type" - - "image_url" - description: "The image part of the prompt message. Only supported with vision models." - description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " - "tool_calls": - type: "array" - items: - type: "object" + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" properties: - "id": - type: "string" - "index": - type: "number" "type": type: "string" enum: - - "function" - "function": + - "json_schema" + "json_schema": type: "object" properties: "name": type: "string" - "arguments": - type: "string" - description: "JSON string arguments for the functions" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" required: - "name" - "arguments" @@ -3770,1317 +4587,73313 @@ paths: - "role" - "content" required: - - "tools" - - "model" - - "model_type" - - "model_parameters" - - "provider" - "messages" - "version": + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": type: "string" - description: "THe version of the deployment" required: - - "id" - - "created" - - "updated" - - "key" - - "description" + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" - "prompt_config" - - "version" - "has_more": - type: "boolean" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" required: - - "object" - - "data" - - "has_more" - "500": - description: "Internal Server Error" - content: - "application/json": - schema: {"$ref": "#/components/schemas/HonoApiError"} - "/v2/deployments/invalidate/{deployment_id}": - delete: - tags: - - "Deployments" - x-speakeasy-group: "deployments" - x-speakeasy-name-override: "invalidate" - operationId: "InvalidDeployment" - description: "Explicitly invalidate a cache of a deployment" - summary: "Invalidates cache" - security: - - ApiKey: [] - parameters: - - schema: - anyOf: - - type: "string" - format: "uuid" - description: "The id of the resource" - readOnly: true - - type: "string" - format: "ulid" - description: "The id of the resource" - readOnly: true - description: "The deployment id that needs to be invalidated" - required: true - name: "deployment_id" - in: "path" - responses: - "204": - description: "No content - successful operation" - "/v2/deployments/get_config": - post: - tags: - - "Deployments" - x-speakeasy-group: "deployments" - x-speakeasy-name-override: "getConfig" - operationId: "DeploymentGetConfig" - description: "Retrieve the deployment configuration" - summary: "Get config" - requestBody: - required: true - content: - "application/json": - schema: - type: "object" - properties: - "key": - type: "string" - description: "The deployment id to invoke" - "inputs": - type: "object" - additionalProperties: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": anyOf: - type: "string" - - type: "number" - - type: "boolean" - description: "Key-value pairs variables to replace in your prompts. If a variable is not provided that is defined in the prompt, the default variables are used." - "context": - type: "object" - additionalProperties: {} - description: "Key-value pairs that match your data model and fields declared in your configuration matrix. If you send multiple prompt keys, the context will be applied to the evaluation of each key." - "prefix_messages": - type: "array" - items: - type: "object" - properties: - "role": + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": type: "string" enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - anyOf: - - type: "string" - - type: "array" - items: - oneOf: - - type: "object" - properties: - "type": - type: "string" - enum: - - "text" - "text": - type: "string" - required: - - "type" - - "text" - description: "Text content part of a prompt message" - - type: "object" - properties: - "type": - type: "string" - enum: - - "image_url" - "image_url": - type: "object" - properties: - "id": - type: "string" - format: "ulid" - description: "The orq.ai id of the image" - readOnly: true - "url": - anyOf: - - type: "string" - - type: "string" - format: "uri" - description: "Either a URL of the image or the base64 encoded data URI." - examples: - - "https://picsum.photos/id/1/200/300" - - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" - "detail": - type: "string" - description: "Specifies the detail level of the image. Currently only supported with OpenAI models" - required: - - "url" - required: - - "type" - - "image_url" - description: "The image part of the prompt message. Only supported with vision models." - description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " - "tool_calls": + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": type: "array" items: type: "object" properties: - "id": - type: "string" - "index": - type: "number" - "type": + "role": type: "string" enum: - - "function" - "function": - type: "object" - properties: - "name": - type: "string" - "arguments": - type: "string" - description: "JSON string arguments for the functions" - required: - - "name" - - "arguments" + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" required: - - "type" - - "function" + - "role" + - "content" required: - - "role" - - "content" - description: "A list of messages to include after the `System` message, but before the `User` and `Assistant` pairs configured in your deployment." - "messages": - type: "array" - items: + - "messages" + "metadata": type: "object" properties: - "role": + "use_cases": + type: "array" + items: + type: "string" + "language": type: "string" - enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - anyOf: - - type: "string" - - type: "array" - items: - oneOf: - - type: "object" - properties: - "type": - type: "string" - enum: - - "text" - "text": - type: "string" - required: - - "type" - - "text" - description: "Text content part of a prompt message" - - type: "object" - properties: - "type": - type: "string" - enum: - - "image_url" - "image_url": - type: "object" - properties: - "id": - type: "string" - format: "ulid" - description: "The orq.ai id of the image" - readOnly: true - "url": - anyOf: - - type: "string" - - type: "string" - format: "uri" - description: "Either a URL of the image or the base64 encoded data URI." - examples: - - "https://picsum.photos/id/1/200/300" - - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" - "detail": - type: "string" - description: "Specifies the detail level of the image. Currently only supported with OpenAI models" - required: - - "url" - required: - - "type" - - "image_url" - description: "The image part of the prompt message. Only supported with vision models." - description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " - "tool_calls": - type: "array" - items: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": type: "object" properties: - "id": + "stream": + type: "boolean" + "model": type: "string" - "index": - type: "number" - "type": + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": type: "string" enum: - - "function" - "function": + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": type: "object" properties: - "name": + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": type: "string" - "arguments": + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": type: "string" - description: "JSON string arguments for the functions" - required: - - "name" - - "arguments" - required: - - "type" - - "function" - required: - - "role" - - "content" - description: "A list of messages to send to the deployment." - "file_ids": - type: "array" - items: - type: "string" - description: "A list of file IDs that are associated with the deployment request." - "metadata": - type: "object" - additionalProperties: {} - description: "Key-value pairs that you want to attach to the log generated by this request." - "chain_id": - type: "string" - description: "Unique ID that identifies a chaining operation. This is useful for tracking a chain of completions across multiple " - "conversation_id": - type: "string" - description: "Unique ID that identifies a chat conversation. This is useful for tracking the same conversation across multiple requests" - "user_id": - anyOf: - - type: "string" - - type: "number" - description: "Unique ID that identifies a user. This is useful for tracking the same user across multiple requests" - "deployment_id": - type: "string" - description: "Unique ID that identifies a deployment entity." - "deployment_variant_id": - type: "string" - description: "Unique ID that identifies a specific variant of a deployment." - "extra_params": - type: "object" - additionalProperties: {} - description: "Utilized for passing additional parameters to the model provider. Exercise caution when using this feature, as the included parameters will overwrite any parameters specified in the deployment prompt configuration." - "invoke_options": - type: "object" - properties: - "include_retrievals": - type: "boolean" - default: false - description: "Whether to include the retrieved knowledge chunks in the response." - required: - - "key" - responses: - "200": - description: "Configurations Retrieved." - content: - "application/json": - schema: - type: "object" - properties: - "id": - type: "string" - description: "A unique identifier for the response. Can be used to add metrics to the transaction." - "provider": - type: "string" - description: "The provider of the model" - "model": - type: "string" - description: "The model of the configuration" - "type": - type: "string" - enum: - - "chat" - - "completion" - - "embedding" - - "vision" - - "image" - - "tts" - - "stt" - - "rerank" - - "moderations" - description: "The type of the model. Current `chat`,`completion` and `image` are supported" - "version": - type: "string" - description: "The current version of the deployment" - "messages": - type: "array" - items: - type: "object" - properties: - "role": - type: "string" - enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - anyOf: - - type: "string" - - type: "array" - items: - oneOf: - - type: "object" - properties: - "type": - type: "string" - enum: - - "text" - "text": - type: "string" - required: - - "type" - - "text" - description: "Text content part of a prompt message" - - type: "object" - properties: - "type": - type: "string" - enum: - - "image_url" - "image_url": - type: "object" - properties: - "id": - type: "string" - format: "ulid" - description: "The orq.ai id of the image" - readOnly: true - "url": - anyOf: - - type: "string" - - type: "string" - format: "uri" - description: "Either a URL of the image or the base64 encoded data URI." - examples: - - "https://picsum.photos/id/1/200/300" - - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" - "detail": - type: "string" - description: "Specifies the detail level of the image. Currently only supported with OpenAI models" - required: - - "url" - required: - - "type" - - "image_url" - description: "The image part of the prompt message. Only supported with vision models." - description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " - "tool_calls": - type: "array" - items: - type: "object" - properties: - "id": - type: "string" - "index": - type: "number" - "type": - type: "string" - enum: - - "function" - "function": + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: type: "object" properties: - "name": - type: "string" - "arguments": + "role": type: "string" - description: "JSON string arguments for the functions" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" required: - - "name" - - "arguments" - required: - - "type" - - "function" + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" required: - - "role" - - "content" - "parameters": + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": type: "object" properties: - "temperature": - type: "number" - description: "Only supported on `chat` and `completion` models." - "maxTokens": - type: "number" - description: "Only supported on `chat` and `completion` models." - "topK": - type: "number" - description: "Only supported on `chat` and `completion` models." - "topP": - type: "number" - description: "Only supported on `chat` and `completion` models." - "frequencyPenalty": - type: "number" - description: "Only supported on `chat` and `completion` models." - "presencePenalty": - type: "number" - description: "Only supported on `chat` and `completion` models." - "numImages": - type: "number" - description: "Only supported on `image` models." - "seed": - type: "number" - description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" - "format": + "stream": + type: "boolean" + "model": type: "string" - enum: - - "url" - - "b64_json" - - "text" - - "json_object" - description: "Only supported on `image` models." - "dimensions": + "model_db_id": type: "string" - description: "Only supported on `image` models." - "quality": + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": type: "string" enum: - - "standard" - - "hd" - description: "Only supported on `image` models." - "style": - type: "string" - description: "Only supported on `image` models." - "responseFormat": - oneOf: - - type: "object" - properties: - "type": - type: "string" - enum: - - "json_schema" - "json_schema": - type: "object" + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" properties: - "name": + "type": type: "string" - "strict": - type: "boolean" - "schema": + enum: + - "json_schema" + "json_schema": type: "object" - additionalProperties: {} + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" required: - - "name" - - "strict" - - "schema" - required: - - "type" - - "json_schema" - - type: "object" - properties: - "type": - type: "string" - enum: - - "json_object" - required: - - "type" - - type: "null" - description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." - "photoRealVersion": + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": type: "string" enum: - - "v1" - - "v2" - description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" - "encoding_format": + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": type: "string" - enum: - - "float" - - "base64" - description: "The format to return the embeddings" - description: "Model Parameters: Not all parameters apply to every model" - "tools": + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": type: "array" items: type: "object" properties: - "type": + "_id": type: "string" - enum: - - "function" - description: "The type of the tool. Currently, only `function` is supported." - "function": + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": type: "object" properties: - "name": + "stream": + type: "boolean" + "model": type: "string" - description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." - "description": + "model_db_id": type: "string" - description: "A description of what the function does, used by the model to choose when and how to call the function." - "parameters": + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": type: "object" - additionalProperties: {} - description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." - required: - - "name" - required: - - "type" - - "function" - description: "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for." - required: + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + required: + - "count" + - "items" + "CreatePromptRequest": + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "display_name": + type: "string" + "domain_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "key": + type: "string" + "type": + type: "string" + enum: + - "prompt" + - "snippet" + - "template" + required: + - "_id" + - "display_name" + - "domain_id" + - "type" + "DeletePromptRequest": + type: "object" + properties: + "id": + type: "string" + description: "Prompt ID" + required: + - "id" + "DuplicatePromptRequest": + type: "object" + properties: + "id": + type: "string" + description: "Prompt ID" + required: + - "id" + "FindOnePromptRequest": + type: "object" + properties: + "id": + type: "string" + description: "Prompt ID" + required: + - "id" + "GetAllPromptsRequest": + type: "object" + properties: + "filters": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "id" + "id": + type: "string" + "path": + type: "string" + required: + - "type" + - "id" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "search" + "value": + type: "string" + "searchPaths": + type: "array" + items: + type: "string" + required: + - "type" + - "value" + - "searchPaths" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "operator": + type: "string" + enum: + - "contains" + - "equals" + "value": + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "value" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "operator": + type: "string" + enum: + - "in" + "values": + type: "array" + items: + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "values" + - "path" + required: + - "filters" + "UpdatePromptRequest": + type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "domain_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "key": + type: "string" + required: + - "_id" + "PromptCreatePromptResponse": + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "display_name": + type: "string" + "domain_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "key": + type: "string" + "type": + type: "string" + enum: + - "prompt" + - "snippet" + - "template" + required: + - "_id" + - "display_name" + - "domain_id" + - "type" + "GetAllPromptsResponse": + type: "object" + properties: + "count": + type: "number" + "items": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + required: + - "count" + - "items" + "UpdatePromptResponse": + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + "GetOnePromptSnippetByKeyRequest": + type: "object" + properties: + "key": + type: "string" + description: "Prompt Snippet Key" + required: + - "key" + "GetOnePromptSnippetByKeyResponse": + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + "GetRemoteConfigRequest": + type: "object" + properties: + "key": + type: "string" + description: "Remote configuration key" + "context": + type: "object" + additionalProperties: {} + description: "Key-value pairs matching your data model, applied to each prompt key." + "metadata": + type: "object" + additionalProperties: {} + description: "Key-value pairs to attach to the log generated by this request." + required: + - "key" + "GetRemoteConfigResponse": + type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + - "string" + - "integer" + - "decimal" + - "list" + - "json" + - "deployment" + "value": {} + required: + - "type" + "WorkflowRun": + oneOf: + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "remoteconfigs" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig" + "remote_config_id": + type: "string" + required: + - "type" + - "remote_config_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig_variant" + "remote_config_variant_id": + type: "string" + required: + - "type" + - "remote_config_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + "data": + type: "object" + properties: + "remote_config_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_key": + type: "string" + "remote_config_type": + type: "string" + "remote_config_version": + type: "number" + "remote_config_variant_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_variant_position": + type: "number" + "remote_config_value": {} + "is_default_matched": + type: "boolean" + "action": + type: "string" + enum: + - "get_config" + - "simulate" + required: + - "remote_config_id" + - "remote_config_key" + - "remote_config_type" + - "remote_config_version" + - "remote_config_variant_id" + - "remote_config_variant_position" + - "is_default_matched" + - "action" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for a remote config workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "deployments" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_key" + "deployment_key": + type: "string" + required: + - "type" + - "deployment_key" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment" + "deployment_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_variant" + "deployment_variant_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_completion" + "deployment_completion_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "chain" + "chain_id": + type: "string" + required: + - "type" + - "chain_id" + description: "Define the relationship between multiple logs that are part of the same chain" + - type: "object" + properties: + "type": + type: "string" + enum: + - "conversation" + "conversation_id": + type: "string" + required: + - "type" + - "conversation_id" + description: "Define the relationship between multiple logs that are part of the same conversation" + "data": + type: "object" + properties: + "deployment_id": + type: "string" + "deployment_key": + type: "string" + "deployment_variant_version": + type: "string" + "deployment_variant_position": + type: "number" + "deployment_variant_id": + type: "string" + format: "uuid" + "is_default_matched": + type: "boolean" + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "get_config" + - "invoke" + - "simulate" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "retries": + type: "array" + items: + type: "object" + properties: + "retry_attempt": + type: "number" + "status": + type: "number" + "message": + type: "string" + "is_fallback": + type: "boolean" + required: + - "retry_attempt" + - "status" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "metadata": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "settings": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "processing_attempts": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "started_at": + type: "string" + "queued_at": + type: "string" + "completed_at": + type: "string" + "errors": + type: "array" + items: + type: "object" + properties: + "code": + type: "number" + "message": + type: "string" + required: + - "code" + - "message" + required: + - "id" + - "started_at" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + "files": + type: "array" + items: + type: "object" + properties: + "file_id": + type: "string" + "file_name": + type: "string" + "object_name": + type: "string" + "content": + type: "string" + required: + - "file_id" + - "file_name" + - "object_name" + - "content" + "cache_key": + type: "string" + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + "is_caching_enabled": + type: "boolean" + "cache_status": + type: "string" + enum: + - "HIT" + - "MISS" + required: + - "deployment_id" + - "deployment_key" + - "deployment_variant_version" + - "deployment_variant_position" + - "deployment_variant_id" + - "is_default_matched" + - "action" + - "prompt_config" + - "variables" + - "retries" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "playgrounds" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground" + "playground_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_block" + "playground_block_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_block_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_completion" + "playground_completion_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "choices" + - "action" + - "prompt_config" + - "variables" + - "billing" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "experiments" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment" + "experiment_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "experiment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_run" + "experiment_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "experiment_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "test_case_run" + "test_case_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_test_case" + "test_case_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + default: "invoke" + "integration_ids": + type: "array" + items: + type: "string" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the experiment workflow run" + description: "The schema for a workflow run" + "WorkflowRunQueryRequest": + type: "object" + properties: + "pagination": + type: "object" + properties: + "page": + type: "number" + "limit": + type: "number" + "lastId": + type: + - "string" + - "null" + required: + - "limit" + "sortingProps": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + description: "The path to sort by" + "direction": + type: "string" + enum: + - "asc" + - "desc" + description: "The direction to sort by" + required: + - "key" + "query": + type: "object" + properties: + "operator": + type: "string" + enum: + - "and" + - "or" + "filters": + type: "array" + items: + anyOf: + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + "value": {} + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "options": + type: "array" + items: + anyOf: + - type: "string" + - type: "number" + "optionsMap": + type: + - "object" + - "null" + additionalProperties: + anyOf: + - type: "string" + - type: "number" + "imageUrlMap": + type: "object" + additionalProperties: + type: "string" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "id" + - "type" + - "options" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + "value": + type: + - "array" + - "null" + items: {} + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "options": + type: "array" + items: + anyOf: + - type: "string" + - type: "number" + "optionsMap": + type: + - "object" + - "null" + additionalProperties: + anyOf: + - type: "string" + - type: "number" + "imageUrlMap": + type: "object" + additionalProperties: + type: "string" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "options" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + "value": + type: "object" + properties: + "criteria": + type: + - "object" + - "null" + properties: + "unit": + anyOf: + - type: "string" + enum: + - "day" + - "week" + - "month" + - "year" + - type: "string" + enum: + - "hours_ago" + - "minutes_ago" + "count": + type: + - "number" + - "null" + "relativeTime": + type: "string" + enum: + - "today" + - "yesterday" + - "one_week_ago" + - "one_month_ago" + - "custom_date" + "customDate": + type: + - "string" + - "null" + "direction": + type: "string" + enum: + - "present" + - "past" + "startDate": + type: + - "string" + - "null" + "endDate": + type: + - "string" + - "null" + "mode": + type: "string" + enum: + - "date" + - "datetime" + required: + - "criteria" + - "mode" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + "value": + anyOf: + - type: "number" + - type: "array" + items: + type: "number" + - type: "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "name" + - "path" + - type: "object" + properties: + "operator": + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + "value": + anyOf: + - {} + - type: "null" + - type: "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "options": + type: "array" + items: + allOf: + - type: "object" + properties: + "name": + type: "string" + "path": + type: "string" + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "name" + - "path" + - "type" + - type: "object" + properties: + "id": + type: "string" + required: + - "id" + "selectedOptionId": + type: + - "string" + - "null" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "id" + - "type" + - "options" + - "selectedOptionId" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + "value": + type: "boolean" + default: false + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "id" + - "type" + - "name" + - "path" + default: [] + required: + - "operator" + "filters": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "id" + "id": + type: "string" + "path": + type: "string" + required: + - "type" + - "id" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "search" + "value": + type: "string" + "searchPaths": + type: "array" + items: + type: "string" + required: + - "type" + - "value" + - "searchPaths" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "operator": + type: "string" + enum: + - "contains" + - "equals" + "value": + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "value" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "operator": + type: "string" + enum: + - "in" + "values": + type: "array" + items: + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "values" + - "path" + "includedFields": + type: "object" + additionalProperties: + type: "string" + required: + - "filters" + "WorkflowRunQueryResponse": + type: "object" + properties: + "count": + type: "number" + description: "Total number of items" + readOnly: true + "items": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "remoteconfigs" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig" + "remote_config_id": + type: "string" + required: + - "type" + - "remote_config_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig_variant" + "remote_config_variant_id": + type: "string" + required: + - "type" + - "remote_config_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + "data": + type: "object" + properties: + "remote_config_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_key": + type: "string" + "remote_config_type": + type: "string" + "remote_config_version": + type: "number" + "remote_config_variant_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_variant_position": + type: "number" + "remote_config_value": {} + "is_default_matched": + type: "boolean" + "action": + type: "string" + enum: + - "get_config" + - "simulate" + required: + - "remote_config_id" + - "remote_config_key" + - "remote_config_type" + - "remote_config_version" + - "remote_config_variant_id" + - "remote_config_variant_position" + - "is_default_matched" + - "action" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for a remote config workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "deployments" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_key" + "deployment_key": + type: "string" + required: + - "type" + - "deployment_key" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment" + "deployment_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_variant" + "deployment_variant_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_completion" + "deployment_completion_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "chain" + "chain_id": + type: "string" + required: + - "type" + - "chain_id" + description: "Define the relationship between multiple logs that are part of the same chain" + - type: "object" + properties: + "type": + type: "string" + enum: + - "conversation" + "conversation_id": + type: "string" + required: + - "type" + - "conversation_id" + description: "Define the relationship between multiple logs that are part of the same conversation" + "data": + type: "object" + properties: + "deployment_id": + type: "string" + "deployment_key": + type: "string" + "deployment_variant_version": + type: "string" + "deployment_variant_position": + type: "number" + "deployment_variant_id": + type: "string" + format: "uuid" + "is_default_matched": + type: "boolean" + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "get_config" + - "invoke" + - "simulate" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "retries": + type: "array" + items: + type: "object" + properties: + "retry_attempt": + type: "number" + "status": + type: "number" + "message": + type: "string" + "is_fallback": + type: "boolean" + required: + - "retry_attempt" + - "status" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "metadata": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "settings": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "processing_attempts": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "started_at": + type: "string" + "queued_at": + type: "string" + "completed_at": + type: "string" + "errors": + type: "array" + items: + type: "object" + properties: + "code": + type: "number" + "message": + type: "string" + required: + - "code" + - "message" + required: + - "id" + - "started_at" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + "files": + type: "array" + items: + type: "object" + properties: + "file_id": + type: "string" + "file_name": + type: "string" + "object_name": + type: "string" + "content": + type: "string" + required: + - "file_id" + - "file_name" + - "object_name" + - "content" + "cache_key": + type: "string" + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + "is_caching_enabled": + type: "boolean" + "cache_status": + type: "string" + enum: + - "HIT" + - "MISS" + required: + - "deployment_id" + - "deployment_key" + - "deployment_variant_version" + - "deployment_variant_position" + - "deployment_variant_id" + - "is_default_matched" + - "action" + - "prompt_config" + - "variables" + - "retries" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "playgrounds" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground" + "playground_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_block" + "playground_block_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_block_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_completion" + "playground_completion_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "choices" + - "action" + - "prompt_config" + - "variables" + - "billing" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "experiments" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment" + "experiment_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "experiment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_run" + "experiment_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "experiment_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "test_case_run" + "test_case_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_test_case" + "test_case_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + default: "invoke" + "integration_ids": + type: "array" + items: + type: "string" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the experiment workflow run" + description: "The schema for a workflow run" + description: "List of items" + uniqueItems: true + "nextLastId": + type: + - "string" + - "null" + required: + - "count" + - "items" + "HonoApiError": + type: "object" + properties: + "code": + type: "string" + description: "HTTP status code" + "message": + type: "string" + description: "Error message" + required: + - "message" + "Deployments": + type: "object" + properties: + "key": + type: "string" + description: "The deployment id to invoke" + "stream": + type: "boolean" + default: false + description: "If set, partial message content will be sent. Tokens will be sent as data-only `server-sent events` as they become available, with the stream terminated by a `data: [DONE]` message." + "inputs": + type: "object" + additionalProperties: + anyOf: + - type: "string" + - type: "number" + - type: "boolean" + description: "Key-value pairs variables to replace in your prompts. If a variable is not provided that is defined in the prompt, the default variables are used." + "context": + type: "object" + additionalProperties: {} + description: "Key-value pairs that match your data model and fields declared in your configuration matrix. If you send multiple prompt keys, the context will be applied to the evaluation of each key." + "prefix_messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "A list of messages to include after the `System` message, but before the `User` and `Assistant` pairs configured in your deployment." + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "A list of messages to send to the deployment." + "file_ids": + type: "array" + items: + type: "string" + description: "A list of file IDs that are associated with the deployment request." + "metadata": + type: "object" + additionalProperties: {} + description: "Key-value pairs that you want to attach to the log generated by this request." + "chain_id": + type: "string" + description: "Unique ID that identifies a chaining operation. This is useful for tracking a chain of completions across multiple " + "conversation_id": + type: "string" + description: "Unique ID that identifies a chat conversation. This is useful for tracking the same conversation across multiple requests" + "user_id": + anyOf: + - type: "string" + - type: "number" + description: "Unique ID that identifies a user. This is useful for tracking the same user across multiple requests" + "deployment_id": + type: "string" + description: "Unique ID that identifies a deployment entity." + "deployment_variant_id": + type: "string" + description: "Unique ID that identifies a specific variant of a deployment." + "extra_params": + type: "object" + additionalProperties: {} + description: "Utilized for passing additional parameters to the model provider. Exercise caution when using this feature, as the included parameters will overwrite any parameters specified in the deployment prompt configuration." + "invoke_options": + type: "object" + properties: + "include_retrievals": + type: "boolean" + default: false + description: "Whether to include the retrieved knowledge chunks in the response." + required: + - "key" + description: "The deployment request payload" +paths: + "/v2/contacts": + post: + tags: + - "Contacts" + x-speakeasy-name-override: "create" + operationId: "CreateContact" + description: "Update or add user information to workspace" + summary: "Update user information" + requestBody: + required: true + description: "Update user information payload" + content: + "application/json": + schema: + type: "object" + properties: + "external_id": + type: "string" + minLength: 1 + description: "Unique string value to identify the contact user in the customer's system" + "display_name": + type: + - "string" + - "null" + description: "Display name or nickname of the user" + "email": + type: + - "string" + - "null" + format: "email" + description: "Email address of the user" + "avatar_url": + type: + - "string" + - "null" + description: "URL linking to the user's avatar image" + "tags": + type: "array" + items: + type: "string" + format: "uuid" + description: "Array of UUIDs representing tags associated with the user" + "metadata": + type: "object" + additionalProperties: {} + description: "Additional custom metadata associated with the user as key-value pairs" + required: + - "external_id" + responses: + "200": + description: "Successful operation" + content: + "application/json": + schema: + type: "object" + properties: + "id": + type: "string" + description: "Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the user" + "external_id": + type: "string" + minLength: 1 + description: "Unique string value to identify the contact user in the customer's system" + "display_name": + type: + - "string" + - "null" + description: "Display name or nickname of the user" + "email": + type: + - "string" + - "null" + format: "email" + description: "Email address of the user" + "avatar_url": + type: + - "string" + - "null" + description: "URL linking to the user's avatar image" + "tags": + type: "array" + items: + type: "string" + format: "uuid" + description: "Array of UUIDs representing tags associated with the user" + "metadata": + type: "object" + additionalProperties: {} + description: "Additional custom metadata associated with the user as key-value pairs" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + required: + - "id" + - "external_id" + "/v2/feedback": + post: + tags: + - "Feedback" + x-speakeasy-name-override: "create" + operationId: "CreateFeedback" + description: "Submit feedback for the LLM transaction via the API" + summary: "Submit feedback" + requestBody: + required: true + description: "Feedback submission payload" + content: + "application/json": + schema: + type: "object" + properties: + "property": + type: "string" + description: "A string describing the specific property or aspect rated." + x-speakeasy-name-override: "field" + "value": + anyOf: + - type: "string" + - type: "array" + items: + type: "string" + description: "The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string." + "trace_id": + type: "string" + description: "The id returned by the [`get_config`]() or [`invoke`](https://docs.orq.ai/reference/post_deployments-invoke-1) endpoints" + required: + - "property" + - "value" + - "trace_id" + example: {"value": ["good"], "property": "rating", "trace_id": "67HTZ65Z9W91HSF51CW68KK1QH"} + responses: + "200": + description: "Successful operation" + content: + "application/json": + schema: + type: "object" + properties: + "property": + type: "string" + description: "A string describing the specific property or aspect rated." + "value": + anyOf: + - type: "string" + - type: "array" + items: + type: "string" + description: "The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string." + "trace_id": + type: "string" + description: "The id returned by the [`get_config`]() or [`invoke`](https://docs.orq.ai/reference/post_deployments-invoke-1) endpoints" + "id": + type: "string" + required: + - "property" + - "value" + - "trace_id" + - "id" + "/v2/deployments": + get: + tags: + - "Deployments" + x-speakeasy-group: "deployments" + x-speakeasy-name-override: "all" + operationId: "Deployments" + description: "Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first." + summary: "List all deployments" + parameters: + - schema: + type: "number" + minimum: 1 + maximum: 50 + default: 10 + description: "A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10" + required: false + description: "A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10" + name: "limit" + in: "query" + - schema: + type: "string" + description: "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `ed33dade-ae32-4959-8c5c-7ae4aad748b5`, your subsequent call can include `after=ed33dade-ae32-4959-8c5c-7ae4aad748b5` in order to fetch the next page of the list." + required: false + description: "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `ed33dade-ae32-4959-8c5c-7ae4aad748b5`, your subsequent call can include `after=ed33dade-ae32-4959-8c5c-7ae4aad748b5` in order to fetch the next page of the list." + name: "after" + in: "query" + responses: + "200": + description: "List of deployments" + content: + "application/json": + schema: + type: "object" + properties: + "object": + type: "string" + enum: + - "list" + "data": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "Unique identifier for the object." + "created": + type: "string" + description: "Date in ISO 8601 format at which the object was created." + "updated": + type: "string" + description: "Date in ISO 8601 format at which the object was last updated." + "key": + type: "string" + description: "The deployment unique key" + "description": + type: "string" + description: "An arbitrary string attached to the object. Often useful for displaying to users." + "prompt_config": + type: "object" + properties: + "tools": + type: "array" + items: + allOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + - type: "object" + properties: + "id": + type: "number" + "model": + type: "string" + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "tools" + - "model" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "version": + type: "string" + description: "THe version of the deployment" + required: + - "id" + - "created" + - "updated" + - "key" + - "description" + - "prompt_config" + - "version" + "has_more": + type: "boolean" + required: + - "object" + - "data" + - "has_more" + "500": + description: "Internal Server Error" + content: + "application/json": + schema: {"$ref": "#/components/schemas/HonoApiError"} + "/v2/deployments/invalidate/{deployment_id}": + delete: + tags: + - "Deployments" + x-speakeasy-group: "deployments" + x-speakeasy-name-override: "invalidate" + operationId: "InvalidDeployment" + description: "Explicitly invalidate a cache of a deployment" + summary: "Invalidates cache" + security: + - ApiKey: [] + parameters: + - schema: + anyOf: + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + description: "The deployment id that needs to be invalidated" + required: true + name: "deployment_id" + in: "path" + responses: + "204": + description: "No content - successful operation" + "/v2/deployments/get_config": + post: + tags: + - "Deployments" + x-speakeasy-group: "deployments" + x-speakeasy-name-override: "getConfig" + operationId: "DeploymentGetConfig" + description: "Retrieve the deployment configuration" + summary: "Get config" + requestBody: + required: true + content: + "application/json": + schema: + type: "object" + properties: + "key": + type: "string" + description: "The deployment id to invoke" + "inputs": + type: "object" + additionalProperties: + anyOf: + - type: "string" + - type: "number" + - type: "boolean" + description: "Key-value pairs variables to replace in your prompts. If a variable is not provided that is defined in the prompt, the default variables are used." + "context": + type: "object" + additionalProperties: {} + description: "Key-value pairs that match your data model and fields declared in your configuration matrix. If you send multiple prompt keys, the context will be applied to the evaluation of each key." + "prefix_messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "A list of messages to include after the `System` message, but before the `User` and `Assistant` pairs configured in your deployment." + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "A list of messages to send to the deployment." + "file_ids": + type: "array" + items: + type: "string" + description: "A list of file IDs that are associated with the deployment request." + "metadata": + type: "object" + additionalProperties: {} + description: "Key-value pairs that you want to attach to the log generated by this request." + "chain_id": + type: "string" + description: "Unique ID that identifies a chaining operation. This is useful for tracking a chain of completions across multiple " + "conversation_id": + type: "string" + description: "Unique ID that identifies a chat conversation. This is useful for tracking the same conversation across multiple requests" + "user_id": + anyOf: + - type: "string" + - type: "number" + description: "Unique ID that identifies a user. This is useful for tracking the same user across multiple requests" + "deployment_id": + type: "string" + description: "Unique ID that identifies a deployment entity." + "deployment_variant_id": + type: "string" + description: "Unique ID that identifies a specific variant of a deployment." + "extra_params": + type: "object" + additionalProperties: {} + description: "Utilized for passing additional parameters to the model provider. Exercise caution when using this feature, as the included parameters will overwrite any parameters specified in the deployment prompt configuration." + "invoke_options": + type: "object" + properties: + "include_retrievals": + type: "boolean" + default: false + description: "Whether to include the retrieved knowledge chunks in the response." + required: + - "key" + responses: + "200": + description: "Configurations Retrieved." + content: + "application/json": + schema: + type: "object" + properties: + "id": + type: "string" + description: "A unique identifier for the response. Can be used to add metrics to the transaction." + "provider": + type: "string" + description: "The provider of the model" + "model": + type: "string" + description: "The model of the configuration" + "type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model. Current `chat`,`completion` and `image` are supported" + "version": + type: "string" + description: "The current version of the deployment" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + "parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "parameters": + type: "object" + additionalProperties: {} + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + required: + - "type" + - "function" + description: "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for." + required: + - "id" + - "provider" + - "model" + - "version" + - "messages" + - "parameters" + description: "The deployment configuration" + "204": + description: "No content - successful operation" + "401": + description: "Unauthorized." + "/v2/deployments/invoke": + post: + tags: + - "Deployments" + x-speakeasy-group: "deployments" + x-speakeasy-name-override: "invoke" + operationId: "DeploymentInvoke" + description: "Invoke a deployment with a given payload" + summary: "Invoke" + requestBody: + required: true + content: + "application/json": + schema: {"$ref": "#/components/schemas/Deployments"} + responses: + "200": + description: "Successful operation" + content: + "application/json": + schema: + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "A unique identifier for the response. Can be used to add metrics to the transaction." + readOnly: true + "created": + type: "string" + format: "date-time" + description: "A timestamp indicating when the object was created. Usually in a standardized format like ISO 8601" + "object": + type: "string" + enum: + - "chat" + - "completion" + - "image" + description: "Indicates the type of model used to generate the response" + "model": + type: "string" + description: "The model used to generate the response" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + description: "The provider used to generate the response" + "is_final": + type: "boolean" + description: "Indicates if the response is the final response" + "integration_id": + type: "string" + description: "Indicates integration id used to generate the response" + "finalized": + type: "string" + format: "date-time" + description: "A timestamp indicating when the object was finalized. Usually in a standardized format like ISO 8601" + "system_fingerprint": + type: + - "string" + - "null" + description: "Provider backed system fingerprint." + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + description: "A list of choices generated by the model" + "retrievals": + type: "array" + items: + type: "object" + properties: + "document": + type: "string" + description: "Content of the retrieved chunk from the knowledge base" + "metadata": + type: "object" + properties: + "file_name": + type: "string" + description: "Name of the file" + "page_number": + type: + - "number" + - "null" + description: "Page number of the chunk" + "file_type": + type: "string" + description: "Type of the file" + "rerank_score": + type: "number" + description: "Rerank scores are normalized to be in the range [0, 1]. Scores close to 1 indicate a high relevance to the query, and scores closer to 0 indicate low relevance. It is not accurate to assume a score of 0.9 means the document is 2x more relevant than a document with a score of 0.45" + "search_score": + type: "number" + description: "Search scores are normalized to be in the range [0, 1]. Search score is calculated based on `[Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity)` algorithm. Scores close to 1 indicate the document is closer to the query, and scores closer to 0 indicate the document is farther from the query." + required: + - "file_name" + - "page_number" + - "file_type" + - "search_score" + description: "Metadata of the retrieved chunk from the knowledge base" + required: + - "document" + - "metadata" + description: "List of documents retrieved from the knowledge base. This property is only available when the `include_retrievals` flag is set to `true` in the invoke settings. When stream is set to true, the `retrievals` property will be returned in the last streamed chunk where the property `is_final` is set to `true`." + "provider_response": + description: "Response returned by the model provider. This functionality is only supported when streaming is not used. If streaming is used, the `provider_response` property will be set to `null`." + required: + - "id" + - "created" + - "object" + - "model" + - "provider" + - "is_final" + - "choices" + description: "Response from the gateway" + "text/event-stream": + schema: + type: "object" + properties: + "data": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "A unique identifier for the response. Can be used to add metrics to the transaction." + readOnly: true + "created": + type: "string" + format: "date-time" + description: "A timestamp indicating when the object was created. Usually in a standardized format like ISO 8601" + "object": + type: "string" + enum: + - "chat" + - "completion" + - "image" + description: "Indicates the type of model used to generate the response" + "model": + type: "string" + description: "The model used to generate the response" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + description: "The provider used to generate the response" + "is_final": + type: "boolean" + description: "Indicates if the response is the final response" + "integration_id": + type: "string" + description: "Indicates integration id used to generate the response" + "finalized": + type: "string" + format: "date-time" + description: "A timestamp indicating when the object was finalized. Usually in a standardized format like ISO 8601" + "system_fingerprint": + type: + - "string" + - "null" + description: "Provider backed system fingerprint." + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + description: "A list of choices generated by the model" + "retrievals": + type: "array" + items: + type: "object" + properties: + "document": + type: "string" + description: "Content of the retrieved chunk from the knowledge base" + "metadata": + type: "object" + properties: + "file_name": + type: "string" + description: "Name of the file" + "page_number": + type: + - "number" + - "null" + description: "Page number of the chunk" + "file_type": + type: "string" + description: "Type of the file" + "rerank_score": + type: "number" + description: "Rerank scores are normalized to be in the range [0, 1]. Scores close to 1 indicate a high relevance to the query, and scores closer to 0 indicate low relevance. It is not accurate to assume a score of 0.9 means the document is 2x more relevant than a document with a score of 0.45" + "search_score": + type: "number" + description: "Search scores are normalized to be in the range [0, 1]. Search score is calculated based on `[Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity)` algorithm. Scores close to 1 indicate the document is closer to the query, and scores closer to 0 indicate the document is farther from the query." + required: + - "file_name" + - "page_number" + - "file_type" + - "search_score" + description: "Metadata of the retrieved chunk from the knowledge base" + required: + - "document" + - "metadata" + description: "List of documents retrieved from the knowledge base. This property is only available when the `include_retrievals` flag is set to `true` in the invoke settings. When stream is set to true, the `retrievals` property will be returned in the last streamed chunk where the property `is_final` is set to `true`." + "provider_response": + description: "Response returned by the model provider. This functionality is only supported when streaming is not used. If streaming is used, the `provider_response` property will be set to `null`." + required: + - "id" + - "created" + - "object" + - "model" + - "provider" + - "is_final" + - "choices" + description: "Response from the gateway" + x-speakeasy-sse-sentinel: "[DONE]" + "204": + description: "No content - successful operation" + "/v2/deployments/{id}/metrics": + post: + tags: + - "Deployments" + x-speakeasy-group: "deployments.metrics" + x-speakeasy-name-override: "create" + operationId: "DeploymentCreateMetric" + description: "Add metrics to a deployment" + summary: "Add metrics" + parameters: + - schema: + type: "string" + description: "Deployment ID" + required: true + description: "Deployment ID" + name: "id" + in: "path" + requestBody: + required: true + description: "The deployment request payload" + content: + "application/json": + schema: + type: "object" + properties: + "metadata": + type: "object" + additionalProperties: {} + description: "Your own custom key-value pairs can be attached to the logs. This is useful for storing additional information related to your interactions with the LLM providers or specifics within your application." + "usage": + type: "object" + properties: + "prompt_tokens": + type: "number" + description: "Number of tokens in the prompt." + "completion_tokens": + type: "number" + description: "Number of tokens in the generated completion." + "total_tokens": + type: "number" + description: "Total number of tokens used in the request (prompt + completion)." + required: + - "prompt_tokens" + - "completion_tokens" + description: "Usage statistics to add to the deployment" + "performance": + type: "object" + properties: + "latency": + type: "number" + description: "Total time in milliseconds of the request to the LLM provider API." + "time_to_first_token": + type: "number" + description: "Total time in milliseconds to generate the first token of the completion." + required: + - "latency" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "A list of messages sent to the model." + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + description: "A list of completion choices. If you are using a `completion` model then you must provide the `completion content` with the chat completion format" + "feedback": + type: "object" + properties: + "score": + type: "integer" + minimum: 0 + maximum: 100 + description: "The feedback score. This allow you to come with specific logic on what a `score` number means" + required: + - "score" + description: "Feedback from the user on the completion" + responses: + "200": + description: "Successful operation" + content: + "application/json": + schema: + type: "object" + properties: + "code": + type: "number" + description: "The status code of the request" + "success": + type: "boolean" + description: "Whether the request was successful" + required: + - "code" + - "success" + "400": + description: "Bad Request" + "401": + description: "Unauthorized." + "/v2/files": + post: + tags: + - "Files" + x-speakeasy-group: "files" + x-speakeasy-name-override: "upload" + operationId: "FileUpload" + summary: "Upload file" + description: "Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config)." + requestBody: + required: true + content: + "multipart/form-data": + schema: + type: "object" + properties: + "file": + type: "string" + description: "The file to be uploaded." + format: "binary" + "purpose": + type: "string" + enum: + - "retrieval" + default: "retrieval" + description: "The intended purpose of the uploaded file." + responses: + "200": + description: "File uploaded successfully" + content: + "application/json": + schema: + type: "object" + properties: + "_id": + type: "string" + "object_name": + type: "string" + description: "path to the file in the storage" + "purpose": + type: "string" + enum: + - "retrieval" + description: "The intended purpose of the uploaded file." + "bytes": + type: "number" + "file_name": + type: "string" + "created": + type: "string" + format: "date-time" + default: "2024-12-01T21:30:45.101Z" + description: "The date and time the resource was created" + readOnly: true + required: + - "_id" + - "object_name" + - "purpose" + - "bytes" + - "file_name" + "400": + description: "Bad request" + "/v2/files/bulk": + post: + tags: + - "Files" + x-speakeasy-group: "files" + x-speakeasy-name-override: "bulkUpload" + operationId: "BulkFileUpload" + summary: "Bulk upload file" + description: "Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config)." + requestBody: + required: true + content: + "multipart/form-data": + schema: + type: "object" + properties: + "files": + type: "array" + items: + type: "string" + description: "The file to be uploaded." + format: "binary" + "purpose": + type: "string" + enum: + - "retrieval" + description: "The intended purpose of the uploaded file." + required: + - "files" + - "purpose" + responses: + "200": + description: "Bulk files uploaded successfully" + content: + "application/json": + schema: + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "object_name": + type: "string" + description: "path to the file in the storage" + "purpose": + type: "string" + enum: + - "retrieval" + description: "The intended purpose of the uploaded file." + "bytes": + type: "number" + "file_name": + type: "string" + "created": + type: "string" + format: "date-time" + default: "2024-12-01T21:30:45.101Z" + description: "The date and time the resource was created" + readOnly: true + required: + - "_id" + - "object_name" + - "purpose" + - "bytes" + - "file_name" + "400": + description: "Bad request" + "/v2/resources/datasets": + post: + tags: + - "resources" + x-speakeasy-group: "dataset" + x-speakeasy-name-override: "create" + x-speakeasy-ignore: true + operationId: "CreateDataset" + security: + - ApiKey: [] + description: "Create a dataset" + summary: "Create a dataset" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + required: + - "display_name" + - "domain_id" + responses: + "200": + description: "Dataset Created." + content: + "application/json": + schema: + type: "object" + properties: + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + required: + - "display_name" + - "domain_id" + get: + tags: + - "resources" + x-speakeasy-group: "dataset" + x-speakeasy-name-override: "getAll" + x-speakeasy-ignore: true + operationId: "GetAllDataset" + security: + - ApiKey: [] + summary: "Get all datasets" + parameters: + - schema: + type: "number" + required: false + name: "page" + in: "query" + - schema: + type: "number" + required: false + name: "limit" + in: "query" + responses: + "200": + description: "Datasets Retrieved." + content: + "application/json": + schema: + type: "object" + properties: + "count": + type: "number" + "page": + type: "number" + "limit": + type: "number" + "totalPages": + type: "number" + "items": + type: "array" + items: + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + "updated_by": + type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "email": + type: "string" + format: "email" + description: "Email of the user" + "display_name": + type: "string" + description: "Display name of the user" + "logo_url": + type: + - "string" + - "null" + format: "uri" + description: "URL of the user logo" + required: + - "id" + - "email" + - "display_name" + - "logo_url" + description: "User model returned from the API" + "updated_by_id": + type: + - "string" + - "null" + format: "uuid" + description: "The user who last updated the dataset" + "items": + type: "array" + items: + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset row model from the API." + required: + - "id" + - "display_name" + - "domain_id" + - "updated_by" + - "updated_by_id" + - "items" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset model from the API" + required: + - "count" + - "page" + - "limit" + - "totalPages" + - "items" + "/v2/resources/datasets/{dataset_id}": + delete: + tags: + - "resources" + x-speakeasy-group: "dataset" + x-speakeasy-name-override: "delete" + x-speakeasy-ignore: true + operationId: "DeleteDataset" + security: + - ApiKey: [] + summary: "Delete a dataset" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + responses: + "204": + description: "No content - successful operation" + "404": + description: "Dataset not found" + get: + tags: + - "resources" + x-speakeasy-group: "dataset" + x-speakeasy-name-override: "getOne" + x-speakeasy-ignore: true + operationId: "GetOneDataset" + security: + - ApiKey: [] + summary: "Get one dataset" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + responses: + "200": + description: "Dataset retrieved." + content: + "application/json": + schema: + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + "updated_by": + type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "email": + type: "string" + format: "email" + description: "Email of the user" + "display_name": + type: "string" + description: "Display name of the user" + "logo_url": + type: + - "string" + - "null" + format: "uri" + description: "URL of the user logo" + required: + - "id" + - "email" + - "display_name" + - "logo_url" + description: "User model returned from the API" + "updated_by_id": + type: + - "string" + - "null" + format: "uuid" + description: "The user who last updated the dataset" + "items": + type: "array" + items: + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset row model from the API." + required: + - "id" + - "display_name" + - "domain_id" + - "updated_by" + - "updated_by_id" + - "items" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset model from the API" + "404": + description: "Dataset not found with the given id" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + patch: + tags: + - "resources" + x-speakeasy-group: "dataset" + x-speakeasy-name-override: "update" + x-speakeasy-ignore: true + operationId: "UpdateDataset" + security: + - ApiKey: [] + description: "Update a dataset" + summary: "Update a dataset" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + responses: + "200": + description: "Dataset updated." + content: + "application/json": + schema: + type: "object" + properties: + "display_name": + type: "string" + description: "Name of the dataset" + "domain_id": + type: "string" + format: "uuid" + description: "Domain ID reference" + "/v2/resources/datasets/{dataset_id}/rows/bulk": + post: + tags: + - "resources" + x-speakeasy-group: "dataset.rows" + x-speakeasy-name-override: "createBulk" + x-speakeasy-ignore: true + operationId: "CreateBulkDatasetRows" + security: + - ApiKey: [] + description: "Create a list of dataset rows" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "datasetRows": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + description: "Expected dataset row model when talking to the API." + example: {"id": "uuid-string", "messages": [{"role": "assistant", "content": "You are a helpful assistant.", "tool_calls": [{"id": "tool-id", "index": 0, "type": "function", "function": {"name": "some-function", "arguments": "some-args"}}]}]} + required: + - "datasetRows" + responses: + "200": + description: "Dataset rows created." + content: + "application/json": + schema: + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + description: "Expected dataset row model when talking to the API." + example: {"id": "uuid-string", "messages": [{"role": "assistant", "content": "You are a helpful assistant.", "tool_calls": [{"id": "tool-id", "index": 0, "type": "function", "function": {"name": "some-function", "arguments": "some-args"}}]}]} + delete: + tags: + - "resources" + x-speakeasy-group: "dataset.rows" + x-speakeasy-name-override: "deleteBulk" + x-speakeasy-ignore: true + operationId: "DeleteBulkDatasetRows" + security: + - ApiKey: [] + summary: "Delete a list of dataset rows" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + responses: + "200": + description: "Dataset rows deleted." + "/v2/resources/datasets/{dataset_id}/rows": + post: + tags: + - "resources" + x-speakeasy-group: "dataset.rows" + x-speakeasy-name-override: "create" + x-speakeasy-ignore: true + operationId: "CreateDatasetRow" + security: + - ApiKey: [] + description: "Create a dataset row" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + responses: + "200": + description: "Dataset row created." + content: + "application/json": + schema: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: - "id" - - "provider" - - "model" - - "version" - "messages" - - "parameters" - description: "The deployment configuration" - "204": - description: "No content - successful operation" + description: "Expected dataset row model when talking to the API." + example: {"id": "uuid-string", "messages": [{"role": "assistant", "content": "You are a helpful assistant.", "tool_calls": [{"id": "tool-id", "index": 0, "type": "function", "function": {"name": "some-function", "arguments": "some-args"}}]}]} + get: + tags: + - "resources" + x-speakeasy-group: "dataset.rows" + x-speakeasy-name-override: "getAll" + x-speakeasy-ignore: true + operationId: "GetAllDatasetRows" + security: + - ApiKey: [] + description: "Retrieve all dataset rows" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + responses: + "200": + description: "Dataset rows Retrieved." + content: + "application/json": + schema: + type: "object" + properties: + "count": + type: "number" + "page": + type: "number" + "limit": + type: "number" + "totalPages": + type: "number" + "items": + type: "array" + items: + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset row model from the API." + required: + - "count" + - "page" + - "limit" + - "totalPages" + - "items" + "/v2/resources/datasets/{dataset_id}/rows/{row_id}": + delete: + tags: + - "resources" + x-speakeasy-group: "dataset.rows" + x-speakeasy-name-override: "delete" + x-speakeasy-ignore: true + operationId: "DeleteDatasetRow" + security: + - ApiKey: [] + summary: "Delete a dataset row" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + - schema: + type: "string" + description: "Dataset row ID" + required: true + description: "Dataset row ID" + name: "row_id" + in: "path" + responses: + "200": + description: "Dataset row deleted." + get: + tags: + - "resources" + x-speakeasy-group: "dataset.rows" + x-speakeasy-name-override: "getOne" + x-speakeasy-ignore: true + operationId: "GetOneDatasetRow" + security: + - ApiKey: [] + summary: "Get one dataset row" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + - schema: + type: "string" + description: "Dataset row ID" + required: true + description: "Dataset row ID" + name: "row_id" + in: "path" + responses: + "200": + description: "Dataset row retrieved." + content: + "application/json": + schema: + allOf: + - type: "object" + properties: + "id": + type: "string" + format: "uuid" + readOnly: true + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "id" + - "messages" + - type: "object" + properties: + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + description: "CreatedUpdatedTime" + description: "Returned dataset row model from the API." + "404": + description: "Dataset row not found with the given id" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + patch: + tags: + - "resources" + x-speakeasy-group: "dataset.rows" + x-speakeasy-name-override: "update" + x-speakeasy-ignore: true + operationId: "UpdateDatasetRow" + security: + - ApiKey: [] + description: "Update a dataset row" + parameters: + - schema: + type: "string" + description: "Dataset ID" + required: true + description: "Dataset ID" + name: "dataset_id" + in: "path" + - schema: + type: "string" + description: "Dataset row ID" + required: true + description: "Dataset row ID" + name: "row_id" + in: "path" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "messages" + responses: + "200": + description: "Dataset updated." + content: + "application/json": + schema: + type: "object" + properties: + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + description: "Input message(s) of the dataset row" + "expected_output": + type: + - "string" + - "null" + description: "Reference of the dataset row" + required: + - "messages" + "/v2/resources/evaluators/templates": + get: + tags: + - "Evaluators" + x-speakeasy-group: "evals.templates" + x-speakeasy-name-override: "all" + x-speakeasy-ignore: true + operationId: "GetEvalTemplates" + description: "List evaluators templates" + summary: "Templates" + responses: + "200": + description: "Successful operation" + content: + "application/json": + schema: + type: "object" + properties: + "object": + type: "string" + enum: + - "list" + "data": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "prompt": + type: "string" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + required: + - "_id" + - "display_name" + - "description" + - "prompt" + - "output_type" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "function": + type: "string" + enum: + - "is_valid_json" + - "bert_score" + - "bleu_score" + - "rouge_n" + - "meteor_score" + - "cosine_similarity" + - "levenshtein_distance" + - "exact_match" + - "contains" + - "contains_all" + - "contains_any" + - "contains_email" + - "contains_url" + - "contains_none" + - "contains_valid_link" + - "ends_with" + - "length_between" + - "length_greater_than" + - "length_less_than" + - "moderations_openai" + - "moderations_google" + - "one_line" + - "regex" + - "start_with" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + required: + - "_id" + - "display_name" + - "description" + - "function" + - "output_type" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + "type": + type: "string" + enum: + - "ragas" + required: + - "_id" + - "display_name" + - "description" + - "ragas_metric" + - "type" + "has_more": + type: "boolean" + required: + - "object" + - "data" + - "has_more" + "/v2/resources/evaluators": + get: + tags: + - "evals" + x-speakeasy-group: "evals" + x-speakeasy-name-override: "all" + x-speakeasy-ignore: true + operationId: "GetEvals" + summary: "Get all evals" + security: + - ApiKey: [] + responses: + "200": + description: "Returns a list of evals" + content: + "application/json": + schema: + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "prompt": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "prompt" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + "function_params": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_none" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_all" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_any" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_email" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_url" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_valid_link" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "start_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "ends_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact_match" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_less_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_between" + "min": + type: "number" + "max": + type: "number" + required: + - "type" + - "min" + - "max" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_greater_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "one_line" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "regex" + "pattern": + type: "string" + required: + - "type" + - "pattern" + - type: "object" + properties: + "type": + type: "string" + enum: + - "is_valid_json" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_openai" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_google" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bleu_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "meteor_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "cosine_similarity" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "levenshtein_distance" + required: + - "type" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "function_params" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "number" + "type": + type: "string" + enum: + - "ragas" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "ragas_metric" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + "type": + type: "string" + enum: + - "json_schema" + "schema": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "schema" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "http_eval" + "url": + type: "string" + "method": + type: "string" + enum: + - "GET" + - "POST" + "headers": + type: "object" + additionalProperties: + type: "string" + "payload": + type: "object" + additionalProperties: {} + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "url" + - "method" + - "headers" + - "payload" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "python_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "typescript_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + "404": + description: "Workspace ID is not found on the request" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + post: + tags: + - "evals" + x-speakeasy-group: "evals" + x-speakeasy-name-override: "create" + x-speakeasy-ignore: true + operationId: "CreateEval" + summary: "Create an evaluator" + security: + - ApiKey: [] + requestBody: + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "prompt": + type: "string" + required: + - "display_name" + - "description" + - "metadata" + - "domain_id" + - "output_type" + - "type" + - "model" + - "prompt" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "number" + "type": + type: "string" + enum: + - "ragas" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + required: + - "display_name" + - "description" + - "metadata" + - "domain_id" + - "output_type" + - "type" + - "model" + - "ragas_metric" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + "type": + type: "string" + enum: + - "json_schema" + "schema": + type: "string" + required: + - "display_name" + - "description" + - "metadata" + - "domain_id" + - "output_type" + - "type" + - "schema" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "http_eval" + "url": + type: "string" + "method": + type: "string" + enum: + - "GET" + - "POST" + "headers": + type: "object" + additionalProperties: + type: "string" + "payload": + type: "object" + additionalProperties: {} + required: + - "display_name" + - "description" + - "metadata" + - "domain_id" + - "output_type" + - "type" + - "url" + - "method" + - "headers" + - "payload" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "python_eval" + required: + - "display_name" + - "description" + - "metadata" + - "domain_id" + - "output_type" + - "code" + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "typescript_eval" + required: + - "display_name" + - "description" + - "metadata" + - "domain_id" + - "output_type" + - "code" + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + "function_params": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_none" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_all" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_any" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_email" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_url" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_valid_link" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "start_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "ends_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact_match" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_less_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_between" + "min": + type: "number" + "max": + type: "number" + required: + - "type" + - "min" + - "max" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_greater_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "one_line" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "regex" + "pattern": + type: "string" + required: + - "type" + - "pattern" + - type: "object" + properties: + "type": + type: "string" + enum: + - "is_valid_json" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_openai" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_google" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bleu_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "meteor_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "cosine_similarity" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "levenshtein_distance" + required: + - "type" + required: + - "display_name" + - "description" + - "metadata" + - "domain_id" + - "output_type" + - "type" + - "function_params" + responses: + "200": + description: "Successfully created an evaluator" + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "prompt": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "prompt" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + "function_params": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_none" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_all" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_any" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_email" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_url" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_valid_link" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "start_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "ends_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact_match" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_less_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_between" + "min": + type: "number" + "max": + type: "number" + required: + - "type" + - "min" + - "max" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_greater_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "one_line" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "regex" + "pattern": + type: "string" + required: + - "type" + - "pattern" + - type: "object" + properties: + "type": + type: "string" + enum: + - "is_valid_json" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_openai" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_google" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bleu_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "meteor_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "cosine_similarity" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "levenshtein_distance" + required: + - "type" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "function_params" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "number" + "type": + type: "string" + enum: + - "ragas" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "ragas_metric" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + "type": + type: "string" + enum: + - "json_schema" + "schema": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "schema" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "http_eval" + "url": + type: "string" + "method": + type: "string" + enum: + - "GET" + - "POST" + "headers": + type: "object" + additionalProperties: + type: "string" + "payload": + type: "object" + additionalProperties: {} + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "url" + - "method" + - "headers" + - "payload" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "python_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "typescript_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + "403": + description: "Domain is not allowed" + "404": + description: "Workspace ID is not found on the request" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + "/v2/resources/evaluators/{id}": + get: + tags: + - "evals" + x-speakeasy-group: "evals" + x-speakeasy-name-override: "get" + x-speakeasy-ignore: true + operationId: "GetEval" + summary: "Get an eval" + security: + - ApiKey: [] + parameters: + - schema: + type: "string" + required: true + name: "id" + in: "path" + responses: + "200": + description: "Returns a single eval" + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "prompt": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "prompt" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + "function_params": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_none" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_all" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_any" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_email" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_url" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_valid_link" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "start_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "ends_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact_match" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_less_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_between" + "min": + type: "number" + "max": + type: "number" + required: + - "type" + - "min" + - "max" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_greater_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "one_line" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "regex" + "pattern": + type: "string" + required: + - "type" + - "pattern" + - type: "object" + properties: + "type": + type: "string" + enum: + - "is_valid_json" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_openai" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_google" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bleu_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "meteor_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "cosine_similarity" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "levenshtein_distance" + required: + - "type" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "function_params" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "number" + "type": + type: "string" + enum: + - "ragas" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "ragas_metric" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + "type": + type: "string" + enum: + - "json_schema" + "schema": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "schema" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "http_eval" + "url": + type: "string" + "method": + type: "string" + enum: + - "GET" + - "POST" + "headers": + type: "object" + additionalProperties: + type: "string" + "payload": + type: "object" + additionalProperties: {} + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "url" + - "method" + - "headers" + - "payload" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "python_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "typescript_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + "404": + description: "Workspace ID is not found on the request" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + patch: + tags: + - "evals" + x-speakeasy-group: "evals" + x-speakeasy-name-override: "update" + x-speakeasy-ignore: true + operationId: "UpdateEval" + summary: "Update an eval" + security: + - ApiKey: [] + parameters: + - schema: + type: "string" + required: true + name: "id" + in: "path" + requestBody: + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "prompt": + type: "string" + required: + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "number" + "type": + type: "string" + enum: + - "ragas" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + required: + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + "type": + type: "string" + enum: + - "json_schema" + "schema": + type: "string" + required: + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "http_eval" + "url": + type: "string" + "method": + type: "string" + enum: + - "GET" + - "POST" + "headers": + type: "object" + additionalProperties: + type: "string" + "payload": + type: "object" + additionalProperties: {} + required: + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "python_eval" + required: + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "typescript_eval" + required: + - "type" + - type: "object" + properties: + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + "function_params": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_none" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_all" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_any" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_email" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_url" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_valid_link" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "start_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "ends_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact_match" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_less_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_between" + "min": + type: "number" + "max": + type: "number" + required: + - "type" + - "min" + - "max" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_greater_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "one_line" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "regex" + "pattern": + type: "string" + required: + - "type" + - "pattern" + - type: "object" + properties: + "type": + type: "string" + enum: + - "is_valid_json" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_openai" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_google" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bleu_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "meteor_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "cosine_similarity" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "levenshtein_distance" + required: + - "type" + required: + - "type" + responses: + "200": + description: "Successfully updated an eval" + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "prompt": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "prompt" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + "function_params": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_none" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_all" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_any" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_email" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_url" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_valid_link" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "start_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "ends_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact_match" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_less_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_between" + "min": + type: "number" + "max": + type: "number" + required: + - "type" + - "min" + - "max" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_greater_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "one_line" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "regex" + "pattern": + type: "string" + required: + - "type" + - "pattern" + - type: "object" + properties: + "type": + type: "string" + enum: + - "is_valid_json" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_openai" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_google" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bleu_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "meteor_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "cosine_similarity" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "levenshtein_distance" + required: + - "type" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "function_params" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "number" + "type": + type: "string" + enum: + - "ragas" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "ragas_metric" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + "type": + type: "string" + enum: + - "json_schema" + "schema": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "schema" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "http_eval" + "url": + type: "string" + "method": + type: "string" + enum: + - "GET" + - "POST" + "headers": + type: "object" + additionalProperties: + type: "string" + "payload": + type: "object" + additionalProperties: {} + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "url" + - "method" + - "headers" + - "payload" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "python_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "typescript_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + "404": + description: "Workspace ID is not found on the request" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + delete: + tags: + - "evals" + x-speakeasy-group: "evals" + x-speakeasy-name-override: "delete" + x-speakeasy-ignore: true + operationId: "DeleteEval" + summary: "Delete an eval" + parameters: + - schema: + type: "string" + required: true + name: "id" + in: "path" + responses: + "200": + description: "Eval deleted" + "404": + description: "Workspace ID is not found on the request" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + "/v2/resources/evaluators/{id}/duplicate": + post: + tags: + - "evals" + x-speakeasy-group: "evals" + x-speakeasy-name-override: "duplicate" + x-speakeasy-ignore: true + operationId: "DuplicateEval" + summary: "Duplicate an evaluator" + security: + - ApiKey: [] + parameters: + - schema: + type: "string" + required: true + name: "id" + in: "path" + responses: + "200": + description: "Successfully duplicated the evaluator" + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "llm_eval" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "prompt": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "prompt" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "function_eval" + "function_params": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_none" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_all" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_any" + "keywords": + type: "array" + items: + type: "string" + required: + - "type" + - "keywords" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_email" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_url" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contains_valid_link" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "start_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "ends_with" + "value": + type: "string" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact_match" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_less_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_between" + "min": + type: "number" + "max": + type: "number" + required: + - "type" + - "min" + - "max" + - type: "object" + properties: + "type": + type: "string" + enum: + - "length_greater_than" + "value": + type: "number" + required: + - "type" + - "value" + - type: "object" + properties: + "type": + type: "string" + enum: + - "one_line" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "regex" + "pattern": + type: "string" + required: + - "type" + - "pattern" + - type: "object" + properties: + "type": + type: "string" + enum: + - "is_valid_json" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_openai" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "moderations_google" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bleu_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "meteor_score" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "cosine_similarity" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "levenshtein_distance" + required: + - "type" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "function_params" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "number" + "type": + type: "string" + enum: + - "ragas" + "model": + type: "object" + properties: + "id": + type: "string" + "integration_id": + type: + - "string" + - "null" + required: + - "id" + "ragas_metric": + type: "string" + enum: + - "context_precision" + - "context_recall" + - "context_entities_recall" + - "noise_sensitivity" + - "response_relevancy" + - "faithfulness" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "model" + - "ragas_metric" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + "type": + type: "string" + enum: + - "json_schema" + "schema": + type: "string" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "schema" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "type": + type: "string" + enum: + - "http_eval" + "url": + type: "string" + "method": + type: "string" + enum: + - "GET" + - "POST" + "headers": + type: "object" + additionalProperties: + type: "string" + "payload": + type: "object" + additionalProperties: {} + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "type" + - "url" + - "method" + - "headers" + - "payload" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "python_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + "description": + type: "string" + "enabled": + type: "boolean" + default: true + "metadata": + type: "object" + properties: + "required_model_with_tools_support": + type: "boolean" + "required_retrieval_context": + type: "boolean" + "required_expected_output": + type: "boolean" + "supported_on_input_type": + type: "boolean" + "supported_on_output_type": + type: "boolean" + "owner": + type: "string" + "created": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "updated": + type: "string" + default: "2024-12-01T21:30:44.996Z" + "created_by_id": + type: "string" + "updated_by_id": + type: "string" + "domain_id": + type: "string" + "guardrail_config": + oneOf: + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "boolean" + "value": + type: "boolean" + required: + - "enabled" + - "type" + - "value" + - type: "object" + properties: + "enabled": + type: "boolean" + "type": + type: "string" + enum: + - "number" + "value": + type: "number" + "operator": + type: "string" + enum: + - "eq" + - "ne" + - "gt" + - "gte" + - "lt" + - "lte" + required: + - "enabled" + - "type" + - "value" + - "operator" + "output_type": + type: "string" + enum: + - "boolean" + - "number" + - "string" + - "enum" + "code": + type: "string" + "type": + type: "string" + enum: + - "typescript_eval" + required: + - "_id" + - "display_name" + - "description" + - "metadata" + - "owner" + - "created_by_id" + - "updated_by_id" + - "domain_id" + - "output_type" + - "code" + - "type" + "403": + description: "Domain is not allowed" + "404": + description: "Workspace ID is not found on the request" + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + "/v2/resources/prompts/templates/query": + post: + tags: + - "resources" + x-speakeasy-group: "prompt.templates" + x-speakeasy-name-override: "getAll" + operationId: "GetAllPromptTemplates" + security: + - ApiKey: [] + summary: "Get all prompt templates" + parameters: + - schema: + type: "string" + required: false + name: "page" + in: "query" + - schema: + type: "string" + required: false + name: "limit" + in: "query" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "filters": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "id" + "id": + type: "string" + "path": + type: "string" + required: + - "type" + - "id" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "search" + "value": + type: "string" + "searchPaths": + type: "array" + items: + type: "string" + required: + - "type" + - "value" + - "searchPaths" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "operator": + type: "string" + enum: + - "contains" + - "equals" + "value": + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "value" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "operator": + type: "string" + enum: + - "in" + "values": + type: "array" + items: + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "values" + - "path" + required: + - "filters" + responses: + "200": + description: "Prompt templates retrieved." + content: + "application/json": + schema: + type: "object" + properties: + "count": + type: "number" + "items": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + required: + - "count" + - "items" + "400": + description: "Bad Request" + "/v2/resources/prompts": + post: + tags: + - "resources" + x-speakeasy-group: "prompts" + x-speakeasy-name-override: "create" + operationId: "CreatePrompt" + security: + - ApiKey: [] + summary: "Create a new prompt" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "display_name": + type: "string" + "domain_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "key": + type: "string" + "type": + type: "string" + enum: + - "prompt" + - "snippet" + - "template" + required: + - "_id" + - "display_name" + - "domain_id" + - "type" + responses: + "200": + description: "Prompt created." + content: + "application/json": + schema: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "display_name": + type: "string" + "domain_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "key": + type: "string" + "type": + type: "string" + enum: + - "prompt" + - "snippet" + - "template" + required: + - "_id" + - "display_name" + - "domain_id" + - "type" + example: {"_id": "ulid-string", "type": "prompt", "display_name": "string", "domain_id": "uuid-string", "description": "Sample description for the prompt"} + "/v2/resources/prompts/{id}/versions": + post: + tags: + - "resources" + x-speakeasy-group: "prompts" + x-speakeasy-name-override: "createVersion" + operationId: "CreatePromptVersion" + security: + - ApiKey: [] + summary: "Create a new prompt version" + parameters: + - schema: + type: "string" + description: "Prompt ID" + required: true + description: "Prompt ID" + name: "id" + in: "path" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "display_name": + type: "string" + maxLength: 128 + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "display_name" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + responses: + "200": + description: "Prompt version created." + content: + "application/json": + schema: + type: "object" + properties: + "_id": + type: "string" + "display_name": + type: "string" + maxLength: 128 + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "display_name" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + "/v2/resources/prompts/{id}": + delete: + tags: + - "resources" + x-speakeasy-group: "prompts" + x-speakeasy-name-override: "delete" + operationId: "DeletePrompt" + security: + - ApiKey: [] + summary: "Delete a prompt" + parameters: + - schema: + type: "string" + description: "Prompt ID" + required: true + description: "Prompt ID" + name: "id" + in: "path" + responses: + "200": + description: "Prompt deleted." + get: + tags: + - "resources" + x-speakeasy-group: "prompts" + x-speakeasy-name-override: "getOne" + operationId: "GetOnePrompt" + security: + - ApiKey: [] + summary: "Get one prompt" + parameters: + - schema: + type: "string" + description: "Prompt ID" + required: true + description: "Prompt ID" + name: "id" + in: "path" + responses: + "200": + description: "Prompt retrieved." + patch: + tags: + - "resources" + x-speakeasy-group: "prompts" + x-speakeasy-name-override: "update" + operationId: "UpdatePrompt" + security: + - ApiKey: [] + summary: "Update a prompt" + parameters: + - schema: + type: "string" + description: "Prompt ID" + required: true + description: "Prompt ID" + name: "id" + in: "path" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "display_name": + type: "string" + "domain_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "key": + type: "string" + responses: + "200": + description: "Prompt updated." + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + "404": + description: "Prompt not found." + content: + "application/json": + schema: + type: "object" + properties: + "message": + type: "string" + required: + - "message" + "/v2/resources/prompts/{id}/duplicate": + get: + tags: + - "resources" + x-speakeasy-group: "prompts" + x-speakeasy-name-override: "duplicate" + operationId: "DuplicatePrompt" + security: + - ApiKey: [] + summary: "Duplicate a prompt" + parameters: + - schema: + type: "string" + description: "Prompt ID" + required: true + description: "Prompt ID" + name: "id" + in: "path" + responses: + "200": + description: "Prompt duplicated." + "/v2/resources/prompts/query": + post: + tags: + - "resources" + x-speakeasy-group: "prompts" + x-speakeasy-name-override: "getAll" + operationId: "GetAllPrompts" + security: + - ApiKey: [] + summary: "Get all prompts" + parameters: + - schema: + type: "string" + required: false + name: "page" + in: "query" + - schema: + type: "string" + required: false + name: "limit" + in: "query" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "filters": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "id" + "id": + type: "string" + "path": + type: "string" + required: + - "type" + - "id" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "search" + "value": + type: "string" + "searchPaths": + type: "array" + items: + type: "string" + required: + - "type" + - "value" + - "searchPaths" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "operator": + type: "string" + enum: + - "contains" + - "equals" + "value": + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "value" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "operator": + type: "string" + enum: + - "in" + "values": + type: "array" + items: + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "values" + - "path" + required: + - "filters" + responses: + "200": + description: "Prompts retrieved." + content: + "application/json": + schema: + type: "object" + properties: + "count": + type: "number" + "page": + type: "number" + "limit": + type: "number" + "totalPages": + type: "number" + "items": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + required: + - "count" + - "page" + - "limit" + - "totalPages" + - "items" + "/v2/resources/prompts/snippets/{key}": + get: + tags: + - "resources" + x-speakeasy-group: "prompt.snippets" + x-speakeasy-name-override: "findOne" + operationId: "FindOnePromptSnippet" + security: + - ApiKey: [] + summary: "Get one prompt snippet" + parameters: + - schema: + type: "string" + description: "Prompt Snippet Key" + required: true + description: "Prompt Snippet Key" + name: "key" + in: "path" + responses: + "200": + description: "Prompt snippet retrieved." + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "prompt" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "key": + type: "string" + "type": + type: "string" + enum: + - "snippet" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "key" + - "type" + description: "Prompt snippet model returned from the API" + - type: "object" + properties: + "_id": + type: "string" + "owner": + anyOf: + - type: "string" + - type: "string" + enum: + - "vendor" + "domain_id": + type: "string" + format: "uuid" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "created": + anyOf: + - type: "string" + format: "date-time" + - type: "string" + default: "2024-12-01T21:30:44.574Z" + description: "The date and time the resource was created" + readOnly: true + format: "date-time" + "updated": + anyOf: + - type: "string" + format: "date-time" + default: "2024-12-01T21:30:44.576Z" + - type: "string" + description: "The date and time the resource was last updated" + readOnly: true + format: "date-time" + "versions": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + "created_by_id": + type: "string" + format: "uuid" + "display_name": + type: "string" + maxLength: 128 + "updated_by_id": + type: "string" + format: "uuid" + "description": + type: + - "string" + - "null" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "content" + required: + - "messages" + "metadata": + type: "object" + properties: + "use_cases": + type: "array" + items: + type: "string" + "language": + type: "string" + "commit": + type: "string" + "timestamp": + type: "string" + required: + - "_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "commit" + - "timestamp" + description: "Prompt version model returned from the API" + "type": + type: "string" + enum: + - "template" + required: + - "_id" + - "owner" + - "domain_id" + - "created_by_id" + - "display_name" + - "updated_by_id" + - "prompt_config" + - "metadata" + - "versions" + - "type" + description: "Prompt template model returned from the API" + "400": + description: "Bad request." + "404": + description: "Prompt snippet not found." + "/v2/remoteconfigs": + post: + tags: + - "Remote Config" + x-speakeasy-name-override: "getConfig" + x-speakeasy-group: "remoteconfig" + operationId: "RemoteConfigsGetConfig" + summary: "Get Configurations" + requestBody: + content: + "application/json": + schema: + type: "object" + properties: + "key": + type: "string" + description: "Remote configuration key" + "context": + type: "object" + additionalProperties: {} + description: "Key-value pairs matching your data model, applied to each prompt key." + "metadata": + type: "object" + additionalProperties: {} + description: "Key-value pairs to attach to the log generated by this request." + required: + - "key" + responses: + "200": + description: "An individual remote config" + content: + "application/json": + schema: + type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + - "string" + - "integer" + - "decimal" + - "list" + - "json" + - "deployment" + "value": {} + required: + - "type" + "400": + description: "Bad request" "401": - description: "Unauthorized." - "/v2/deployments/invoke": + description: "Unauthorized" + "404": + description: "Remote config not found" + "500": + description: "Internal server error" + "/v2/logs/query": post: - tags: - - "Deployments" - x-speakeasy-group: "deployments" - x-speakeasy-name-override: "invoke" - operationId: "DeploymentInvoke" - description: "Invoke a deployment with a given payload" - summary: "Invoke" + x-speakeasy-ignore: true requestBody: - required: true content: "application/json": - schema: {"$ref": "#/components/schemas/Deployments"} + schema: + type: "object" + properties: + "pagination": + type: "object" + properties: + "page": + type: "number" + "limit": + type: "number" + "lastId": + type: + - "string" + - "null" + required: + - "limit" + "sortingProps": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + description: "The path to sort by" + "direction": + type: "string" + enum: + - "asc" + - "desc" + description: "The direction to sort by" + required: + - "key" + "query": + type: "object" + properties: + "operator": + type: "string" + enum: + - "and" + - "or" + "filters": + type: "array" + items: + anyOf: + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + "value": {} + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "options": + type: "array" + items: + anyOf: + - type: "string" + - type: "number" + "optionsMap": + type: + - "object" + - "null" + additionalProperties: + anyOf: + - type: "string" + - type: "number" + "imageUrlMap": + type: "object" + additionalProperties: + type: "string" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "id" + - "type" + - "options" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + "value": + type: + - "array" + - "null" + items: {} + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "options": + type: "array" + items: + anyOf: + - type: "string" + - type: "number" + "optionsMap": + type: + - "object" + - "null" + additionalProperties: + anyOf: + - type: "string" + - type: "number" + "imageUrlMap": + type: "object" + additionalProperties: + type: "string" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "options" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + "value": + type: "object" + properties: + "criteria": + type: + - "object" + - "null" + properties: + "unit": + anyOf: + - type: "string" + enum: + - "day" + - "week" + - "month" + - "year" + - type: "string" + enum: + - "hours_ago" + - "minutes_ago" + "count": + type: + - "number" + - "null" + "relativeTime": + type: "string" + enum: + - "today" + - "yesterday" + - "one_week_ago" + - "one_month_ago" + - "custom_date" + "customDate": + type: + - "string" + - "null" + "direction": + type: "string" + enum: + - "present" + - "past" + "startDate": + type: + - "string" + - "null" + "endDate": + type: + - "string" + - "null" + "mode": + type: "string" + enum: + - "date" + - "datetime" + required: + - "criteria" + - "mode" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + "value": + anyOf: + - type: "number" + - type: "array" + items: + type: "number" + - type: "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "value" + - "id" + - "type" + - "name" + - "path" + - type: "object" + properties: + "operator": + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + "value": + anyOf: + - {} + - type: "null" + - type: "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "options": + type: "array" + items: + allOf: + - type: "object" + properties: + "name": + type: "string" + "path": + type: "string" + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "name" + - "path" + - "type" + - type: "object" + properties: + "id": + type: "string" + required: + - "id" + "selectedOptionId": + type: + - "string" + - "null" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "id" + - "type" + - "options" + - "selectedOptionId" + - "name" + - "path" + - type: "object" + properties: + "operator": + type: "string" + enum: + - "is" + "value": + type: "boolean" + default: false + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "type": + type: "string" + enum: + - "string" + - "multi-value-array" + - "single-value-array" + - "number" + - "date" + - "object" + - "boolean" + "name": + type: "string" + "path": + type: "string" + "hideOperators": + type: "array" + items: + anyOf: + - type: "string" + enum: + - "is" + - "is_not" + - "contains" + - "does_not_contain" + - "starts_with" + - "ends_with" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "equals" + - "is_not_equal" + - "is_greater_than" + - "is_less_than" + - "is_greater_than_or_equal_to" + - "is_less_than_or_equal_to" + - "is_between" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_not" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "contains" + - "does_not_contain" + - "is_empty" + - "is_not_empty" + - type: "string" + enum: + - "is" + - "is_before" + - "is_on_or_before" + - "is_between" + - "is_relative_today" + - "is_relative_time" + - "is_empty" + - "is_not_empty" + required: + - "operator" + - "id" + - "type" + - "name" + - "path" + default: [] + required: + - "operator" + "filters": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "id" + "id": + type: "string" + "path": + type: "string" + required: + - "type" + - "id" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "search" + "value": + type: "string" + "searchPaths": + type: "array" + items: + type: "string" + required: + - "type" + - "value" + - "searchPaths" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "operator": + type: "string" + enum: + - "contains" + - "equals" + "value": + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "value" + - "path" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "operator": + type: "string" + enum: + - "in" + "values": + type: "array" + items: + type: "string" + "path": + type: "string" + required: + - "type" + - "operator" + - "values" + - "path" + "includedFields": + type: "object" + additionalProperties: + type: "string" + required: + - "filters" responses: "200": - description: "Successful operation" + description: "Returns a list of workflow runs" + content: + "application/json": + schema: + type: "object" + properties: + "count": + type: "number" + description: "Total number of items" + readOnly: true + "items": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "remoteconfigs" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig" + "remote_config_id": + type: "string" + required: + - "type" + - "remote_config_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig_variant" + "remote_config_variant_id": + type: "string" + required: + - "type" + - "remote_config_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + "data": + type: "object" + properties: + "remote_config_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_key": + type: "string" + "remote_config_type": + type: "string" + "remote_config_version": + type: "number" + "remote_config_variant_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_variant_position": + type: "number" + "remote_config_value": {} + "is_default_matched": + type: "boolean" + "action": + type: "string" + enum: + - "get_config" + - "simulate" + required: + - "remote_config_id" + - "remote_config_key" + - "remote_config_type" + - "remote_config_version" + - "remote_config_variant_id" + - "remote_config_variant_position" + - "is_default_matched" + - "action" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for a remote config workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "deployments" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_key" + "deployment_key": + type: "string" + required: + - "type" + - "deployment_key" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment" + "deployment_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_variant" + "deployment_variant_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_completion" + "deployment_completion_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "chain" + "chain_id": + type: "string" + required: + - "type" + - "chain_id" + description: "Define the relationship between multiple logs that are part of the same chain" + - type: "object" + properties: + "type": + type: "string" + enum: + - "conversation" + "conversation_id": + type: "string" + required: + - "type" + - "conversation_id" + description: "Define the relationship between multiple logs that are part of the same conversation" + "data": + type: "object" + properties: + "deployment_id": + type: "string" + "deployment_key": + type: "string" + "deployment_variant_version": + type: "string" + "deployment_variant_position": + type: "number" + "deployment_variant_id": + type: "string" + format: "uuid" + "is_default_matched": + type: "boolean" + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "get_config" + - "invoke" + - "simulate" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "retries": + type: "array" + items: + type: "object" + properties: + "retry_attempt": + type: "number" + "status": + type: "number" + "message": + type: "string" + "is_fallback": + type: "boolean" + required: + - "retry_attempt" + - "status" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "metadata": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "settings": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "processing_attempts": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "started_at": + type: "string" + "queued_at": + type: "string" + "completed_at": + type: "string" + "errors": + type: "array" + items: + type: "object" + properties: + "code": + type: "number" + "message": + type: "string" + required: + - "code" + - "message" + required: + - "id" + - "started_at" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + "files": + type: "array" + items: + type: "object" + properties: + "file_id": + type: "string" + "file_name": + type: "string" + "object_name": + type: "string" + "content": + type: "string" + required: + - "file_id" + - "file_name" + - "object_name" + - "content" + "cache_key": + type: "string" + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + "is_caching_enabled": + type: "boolean" + "cache_status": + type: "string" + enum: + - "HIT" + - "MISS" + required: + - "deployment_id" + - "deployment_key" + - "deployment_variant_version" + - "deployment_variant_position" + - "deployment_variant_id" + - "is_default_matched" + - "action" + - "prompt_config" + - "variables" + - "retries" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "playgrounds" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground" + "playground_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_block" + "playground_block_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_block_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_completion" + "playground_completion_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "choices" + - "action" + - "prompt_config" + - "variables" + - "billing" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "experiments" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment" + "experiment_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "experiment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_run" + "experiment_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "experiment_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "test_case_run" + "test_case_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_test_case" + "test_case_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + default: "invoke" + "integration_ids": + type: "array" + items: + type: "string" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the experiment workflow run" + description: "The schema for a workflow run" + description: "List of items" + uniqueItems: true + "nextLastId": + type: + - "string" + - "null" + required: + - "count" + - "items" + "400": + description: "Bad request - validation error" content: "application/json": schema: type: "object" properties: - "id": - type: "string" - format: "ulid" - description: "A unique identifier for the response. Can be used to add metrics to the transaction." - readOnly: true - "created": - type: "string" - format: "date-time" - description: "A timestamp indicating when the object was created. Usually in a standardized format like ISO 8601" - "object": - type: "string" - enum: - - "chat" - - "completion" - - "image" - - "vision" - description: "Indicates the type of model used to generate the response" - "model": + "code": + type: "number" + description: "HTTP status code" + "error": type: "string" - description: "The model used to generate the response" - "provider": + description: "Error message" + "source": type: "string" enum: - - "cohere" - - "openai" - - "anthropic" - - "huggingface" - - "replicate" - - "google" - - "google-ai" - - "azure" - - "aws" - - "anyscale" - - "perplexity" - - "groq" - - "fal" - - "leonardoai" - - "nvidia" - - "jina" - description: "The provider used to generate the response" - "is_final": - type: "boolean" - description: "Indicates if the response is the final response" - "integration_id": - type: "string" - description: "Indicates integration id used to generate the response" - "finalized": + - "provider" + - "system" + description: "The source where the error came from" + required: + - "code" + - "error" + - "source" + "403": + description: "Authorization error" + content: + "application/json": + schema: + type: "object" + properties: + "message": type: "string" - format: "date-time" - description: "A timestamp indicating when the object was finalized. Usually in a standardized format like ISO 8601" - "system_fingerprint": - type: - - "string" - - "null" - description: "Provider backed system fingerprint." - "choices": - type: "array" - items: - type: "object" - properties: - "index": - type: "number" - "message": - anyOf: + required: + - "message" + "500": + description: "Internal server error" + content: + "application/json": + schema: + type: "object" + properties: + "code": + type: "number" + description: "HTTP status code" + "error": + type: "string" + description: "Error message" + "source": + type: "string" + enum: + - "provider" + - "system" + description: "The source where the error came from" + required: + - "code" + - "error" + - "source" + "/v2/logs/{id}": + get: + x-speakeasy-ignore: true + parameters: + - schema: + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: true + name: "id" + in: "path" + responses: + "200": + description: "Returns a single workflow run" + content: + "application/json": + schema: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "remoteconfigs" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig" + "remote_config_id": + type: "string" + required: + - "type" + - "remote_config_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "remoteconfig_variant" + "remote_config_variant_id": + type: "string" + required: + - "type" + - "remote_config_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + "data": + type: "object" + properties: + "remote_config_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_key": + type: "string" + "remote_config_type": + type: "string" + "remote_config_version": + type: "number" + "remote_config_variant_id": + anyOf: + - type: "string" + format: "uuid" + - type: "string" + "remote_config_variant_position": + type: "number" + "remote_config_value": {} + "is_default_matched": + type: "boolean" + "action": + type: "string" + enum: + - "get_config" + - "simulate" + required: + - "remote_config_id" + - "remote_config_key" + - "remote_config_type" + - "remote_config_version" + - "remote_config_variant_id" + - "remote_config_variant_position" + - "is_default_matched" + - "action" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for a remote config workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "deployments" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_key" + "deployment_key": + type: "string" + required: + - "type" + - "deployment_key" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment" + "deployment_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_variant" + "deployment_variant_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_variant_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "deployment_completion" + "deployment_completion_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "deployment_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "chain" + "chain_id": + type: "string" + required: + - "type" + - "chain_id" + description: "Define the relationship between multiple logs that are part of the same chain" + - type: "object" + properties: + "type": + type: "string" + enum: + - "conversation" + "conversation_id": + type: "string" + required: + - "type" + - "conversation_id" + description: "Define the relationship between multiple logs that are part of the same conversation" + "data": + type: "object" + properties: + "deployment_id": + type: "string" + "deployment_key": + type: "string" + "deployment_variant_version": + type: "string" + "deployment_variant_position": + type: "number" + "deployment_variant_id": + type: "string" + format: "uuid" + "is_default_matched": + type: "boolean" + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "get_config" + - "invoke" + - "simulate" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "retries": + type: "array" + items: + type: "object" + properties: + "retry_attempt": + type: "number" + "status": + type: "number" + "message": + type: "string" + "is_fallback": + type: "boolean" + required: + - "retry_attempt" + - "status" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "metadata": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "settings": + type: "object" + properties: + "output_masking": + type: "boolean" + default: false + "is_caching_enabled": + type: "boolean" + default: false + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + - type: "null" + "evaluators": + type: "array" + items: + oneOf: + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "evaluator" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + - type: "object" + properties: + "_id": + type: "string" + "config_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + "evaluator_id": + type: "string" + "evaluator_enabled": + type: "boolean" + "sample_rate": + type: "number" + "type": + type: "string" + enum: + - "guardrail" + required: + - "_id" + - "config_type" + - "evaluator_id" + - "type" + "guardrails_behavior": + type: "string" + enum: + - "retry" + - "fallback" + "processing_attempts": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "started_at": + type: "string" + "queued_at": + type: "string" + "completed_at": + type: "string" + "errors": + type: "array" + items: + type: "object" + properties: + "code": + type: "number" + "message": + type: "string" + required: + - "code" + - "message" + required: + - "id" + - "started_at" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + "files": + type: "array" + items: + type: "object" + properties: + "file_id": + type: "string" + "file_name": + type: "string" + "object_name": + type: "string" + "content": + type: "string" + required: + - "file_id" + - "file_name" + - "object_name" + - "content" + "cache_key": + type: "string" + "cache_config": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "exact" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + required: + - "type" + description: "Schema for exact matching type of cache." + - type: "object" + properties: + "type": + type: "string" + enum: + - "semantic" + "model_config": + type: "object" + properties: + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + description: "Configuration of embedding model to be used" + "ttl": + type: "number" + default: 0 + description: "Time To Live" + "similarity_score_threshold": + type: "number" + default: 0 + description: "A floating-point number typically ranging from 0 to 1." + required: + - "type" + - "model_config" + description: "Schema for exact matching type of cache." + "is_caching_enabled": + type: "boolean" + "cache_status": + type: "string" + enum: + - "HIT" + - "MISS" + required: + - "deployment_id" + - "deployment_key" + - "deployment_variant_version" + - "deployment_variant_position" + - "deployment_variant_id" + - "is_default_matched" + - "action" + - "prompt_config" + - "variables" + - "retries" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_eval" + "workflow_run": + type: "object" + properties: + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": + type: "string" + enum: + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" + properties: + "workflow_run_id": + type: "string" + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": + type: + - "string" + - "null" + required: + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "playgrounds" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground" + "playground_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_block" + "playground_block_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_block_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "playground_completion" + "playground_completion_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "playground_completion_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "integration_ids": + type: "array" + items: + type: "string" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "choices" + - "action" + - "prompt_config" + - "variables" + - "billing" + - "prompt_snippets" + required: + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the deployment workflow run" + - type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The unique identifier for the workflow run" + readOnly: true + "workspace_id": + type: "string" + format: "uuid" + description: "The unique identifier for the workspace" + readOnly: true + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "project_id": + anyOf: + - type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + - type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + description: "The optional project_id for the entity of the event" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" - type: "object" properties: - "role": + "type": type: "string" enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": + - "boolean" + "value": type: - - "string" + - "boolean" - "null" - "tool_calls": + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": type: "array" items: - type: "object" - properties: - "id": - type: "string" - "index": - type: "number" - "type": - type: "string" - enum: - - "function" - "function": - type: "object" + oneOf: + - type: "object" properties: - "name": + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "rouge_n" + "value": + type: "object" + properties: + "rouge_1": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_2": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "rouge_l": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + required: + - "rouge_1" + - "rouge_2" + - "rouge_l" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "bert_score" + "value": + type: "object" + properties: + "f1": + type: "number" + "precision": + type: "number" + "recall": + type: "number" + required: + - "f1" + - "precision" + - "recall" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": type: "string" - "arguments": + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": type: "string" - description: "JSON string arguments for the functions" required: - - "name" - - "arguments" - required: - - "type" - - "function" - required: - - "role" - - "tool_calls" - - type: "object" - properties: - "role": + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": type: "string" enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - type: - - "string" - - "null" + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" required: - - "role" - - "content" + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" - type: "object" properties: - "role": + "type": type: "string" enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "url": - type: "string" - required: - - "role" - - "url" - "finish_reason": - type: - - "string" - - "null" - required: - - "index" - description: "A list of choices generated by the model" - "retrievals": - type: "array" - items: - type: "object" - properties: - "document": - type: "string" - description: "Content of the retrieved chunk from the knowledge base" - "metadata": - type: "object" - properties: - "file_name": - type: "string" - description: "Name of the file" - "page_number": - type: - - "number" - - "null" - description: "Page number of the chunk" - "file_type": - type: "string" - description: "Type of the file" - "rerank_score": - type: "number" - description: "Rerank scores are normalized to be in the range [0, 1]. Scores close to 1 indicate a high relevance to the query, and scores closer to 0 indicate low relevance. It is not accurate to assume a score of 0.9 means the document is 2x more relevant than a document with a score of 0.45" - "search_score": - type: "number" - description: "Search scores are normalized to be in the range [0, 1]. Search score is calculated based on `[Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity)` algorithm. Scores close to 1 indicate the document is closer to the query, and scores closer to 0 indicate the document is farther from the query." - required: - - "file_name" - - "page_number" - - "file_type" - - "search_score" - description: "Metadata of the retrieved chunk from the knowledge base" - required: - - "document" - - "metadata" - description: "List of documents retrieved from the knowledge base. This property is only available when the `include_retrievals` flag is set to `true` in the invoke settings. When stream is set to true, the `retrievals` property will be returned in the last streamed chunk where the property `is_final` is set to `true`." - "provider_response": - description: "Response returned by the model provider. This functionality is only supported when streaming is not used. If streaming is used, the `provider_response` property will be set to `null`." - required: - - "id" - - "created" - - "object" - - "model" - - "provider" - - "is_final" - - "choices" - description: "Response from the gateway" - "text/event-stream": - schema: - type: "object" - properties: - "data": - type: "object" - properties: - "id": - type: "string" - format: "ulid" - description: "A unique identifier for the response. Can be used to add metrics to the transaction." - readOnly: true - "created": - type: "string" - format: "date-time" - description: "A timestamp indicating when the object was created. Usually in a standardized format like ISO 8601" - "object": - type: "string" - enum: - - "chat" - - "completion" - - "image" - description: "Indicates the type of model used to generate the response" - "model": - type: "string" - description: "The model used to generate the response" - "provider": - type: "string" - enum: - - "cohere" - - "openai" - - "anthropic" - - "huggingface" - - "replicate" - - "google" - - "google-ai" - - "azure" - - "aws" - - "anyscale" - - "perplexity" - - "groq" - - "fal" - - "leonardoai" - - "nvidia" - description: "The provider used to generate the response" - "is_final": - type: "boolean" - description: "Indicates if the response is the final response" - "integration_id": - type: "string" - description: "Indicates integration id used to generate the response" - "finalized": - type: "string" - format: "date-time" - description: "A timestamp indicating when the object was finalized. Usually in a standardized format like ISO 8601" - "system_fingerprint": - type: - - "string" - - "null" - description: "Provider backed system fingerprint." - "choices": - type: "array" - items: - type: "object" - properties: - "index": - type: "number" - "message": - anyOf: - - type: "object" + - "llm_eval" + "workflow_run": + type: "object" properties: - "role": + "id": + type: "string" + "workflow_metadata": + type: "object" + additionalProperties: {} + description: "Metadata for the workflow run" + "workflow_input": + type: "object" + additionalProperties: {} + description: "Input for the workflow run" + "workflow_output": + type: "object" + additionalProperties: {} + description: "Output for the workflow run" + "request_properties": + type: "object" + properties: + "source": + type: "string" + "location": + type: "string" + "latitude": + type: "string" + "longitude": + type: "string" + "response_time": + type: "number" + "metadata": + type: "object" + additionalProperties: {} + "status": + type: "number" + "context": + type: "object" + additionalProperties: {} + "extra_params": + type: "object" + additionalProperties: {} + description: "An optional field that is filled if the workflow was triggered by an HTTP request" + "started_at": + type: "string" + format: "date-time" + "finished_at": + type: "string" + format: "date-time" + "product_type": type: "string" enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - type: - - "string" - - "null" - "tool_calls": + - "remoteconfigs" + - "deployments" + - "experiments" + - "playgrounds" + - "llm_evaluator" + - "knowledge" + - "router" + - "workflows" + description: "Orquesta product" + "related_entities": type: "array" items: - type: "object" - properties: - "id": - type: "string" - "index": - type: "number" - "type": - type: "string" - enum: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "evals": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "string" + "value": + type: + - "string" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "number" + "value": + type: + - "number" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "boolean" + "value": + type: + - "boolean" + - "null" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "string_array" + "values": + type: "array" + items: + type: "string" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "values" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "data": + type: "object" + properties: + "choices": + type: "array" + items: + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "url": + type: "string" + required: + - "role" + - "url" + "finish_reason": + type: + - "string" + - "null" + required: + - "index" + "action": + type: "string" + enum: + - "invoke" + "prompt_config": + type: "object" + properties: + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": + type: "string" + enum: + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": + type: "array" + items: + type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" + required: + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" + properties: + "latency": + type: "number" + "first_time_to_token": + type: + - "number" + - "null" + "tokens_per_second": + type: + - "number" + - "null" + required: + - "latency" + "usage": + type: "object" + properties: + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" + required: + - "billable" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" - "function" - "function": + "prompt_snippets": + type: "array" + items: type: "object" properties: - "name": + "_id": type: "string" - "arguments": + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": type: "string" - description: "JSON string arguments for the functions" required: - - "name" - - "arguments" + - "_id" + - "key" + - "value" + required: + - "action" + - "prompt_config" + - "variables" + - "prompt_snippets" + required: + - "id" + - "started_at" + - "product_type" + - "related_entities" + - "evals" + - "data" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true required: - "type" - - "function" - required: - - "role" - - "tool_calls" - - type: "object" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "workflow_run" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "llm_evaluator" + "value": + type: + - "object" + - "null" properties: - "role": + "workflow_run_id": type: "string" - enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": + "value": + anyOf: + - type: "number" + - type: "boolean" + "explanation": type: - "string" - "null" required: - - "role" - - "content" - - type: "object" - properties: - "role": - type: "string" - enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "url": - type: "string" - required: - - "role" - - "url" - "finish_reason": - type: - - "string" - - "null" - required: - - "index" - description: "A list of choices generated by the model" - "retrievals": + - "workflow_run_id" + - "value" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "status": + type: "string" + enum: + - "pending" + - "completed" + - "failed" + "started_at": + type: "string" + "finished_at": + type: "string" + "related_entities": + type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + - type: "object" + properties: + "type": + type: "string" + enum: + - "contact" + "contact_id": + type: "string" + required: + - "type" + - "contact_id" + description: "Define the user set using the SDK" + - type: "object" + properties: + "type": + type: "string" + enum: + - "human_eval" + "human_eval_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "human_eval_id" + description: "Define the relationship between an entity and a human eval, also known as feedback" + - type: "object" + properties: + "type": + type: "string" + enum: + - "evaluator" + "evaluator_id": + type: "string" + "evaluator_metric_name": + type: "string" + required: + - "type" + - "evaluator_id" + description: "Define the relationship between an evaluator and an entity. Can be LLM Evals, Code Evals or HTTP Evals" + "passed": + type: "boolean" + "evaluator_type": + type: "string" + enum: + - "input_evaluator" + - "output_evaluator" + - "input_guardrail" + - "output_guardrail" + required: + - "type" + - "value" + - "id" + - "status" + - "started_at" + - "related_entities" + - "evaluator_type" + "product_type": + type: "string" + enum: + - "experiments" + "related_entities": type: "array" items: - type: "object" - properties: - "document": - type: "string" - description: "Content of the retrieved chunk from the knowledge base" - "metadata": - type: "object" + oneOf: + - type: "object" properties: - "file_name": + "type": type: "string" - description: "Name of the file" - "page_number": - type: - - "number" - - "null" - description: "Page number of the chunk" - "file_type": + enum: + - "experiment" + "experiment_id": type: "string" - description: "Type of the file" - "rerank_score": - type: "number" - description: "Rerank scores are normalized to be in the range [0, 1]. Scores close to 1 indicate a high relevance to the query, and scores closer to 0 indicate low relevance. It is not accurate to assume a score of 0.9 means the document is 2x more relevant than a document with a score of 0.45" - "search_score": - type: "number" - description: "Search scores are normalized to be in the range [0, 1]. Search score is calculated based on `[Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity)` algorithm. Scores close to 1 indicate the document is closer to the query, and scores closer to 0 indicate the document is farther from the query." + format: "uuid" + description: "The id of the resource" + readOnly: true required: - - "file_name" - - "page_number" - - "file_type" - - "search_score" - description: "Metadata of the retrieved chunk from the knowledge base" - required: - - "document" - - "metadata" - description: "List of documents retrieved from the knowledge base. This property is only available when the `include_retrievals` flag is set to `true` in the invoke settings. When stream is set to true, the `retrievals` property will be returned in the last streamed chunk where the property `is_final` is set to `true`." - "provider_response": - description: "Response returned by the model provider. This functionality is only supported when streaming is not used. If streaming is used, the `provider_response` property will be set to `null`." - required: - - "id" - - "created" - - "object" - - "model" - - "provider" - - "is_final" - - "choices" - description: "Response from the gateway" - x-speakeasy-sse-sentinel: "[DONE]" - "204": - description: "No content - successful operation" - "/v2/deployments/{id}/metrics": - post: - tags: - - "Deployments" - x-speakeasy-group: "deployments.metrics" - x-speakeasy-name-override: "create" - operationId: "DeploymentCreateMetric" - description: "Add metrics to a deployment" - summary: "Add metrics" - parameters: - - schema: - type: "string" - description: "Deployment ID" - required: true - description: "Deployment ID" - name: "id" - in: "path" - requestBody: - required: true - description: "The deployment request payload" - content: - "application/json": - schema: - type: "object" - properties: - "metadata": - type: "object" - additionalProperties: {} - description: "Your own custom key-value pairs can be attached to the logs. This is useful for storing additional information related to your interactions with the LLM providers or specifics within your application." - "usage": - type: "object" - properties: - "prompt_tokens": - type: "number" - description: "Number of tokens in the prompt." - "completion_tokens": - type: "number" - description: "Number of tokens in the generated completion." - "total_tokens": - type: "number" - description: "Total number of tokens used in the request (prompt + completion)." - required: - - "prompt_tokens" - - "completion_tokens" - description: "Usage statistics to add to the deployment" - "performance": - type: "object" - properties: - "latency": - type: "number" - description: "Total time in milliseconds of the request to the LLM provider API." - "time_to_first_token": - type: "number" - description: "Total time in milliseconds to generate the first token of the completion." - required: - - "latency" - "messages": - type: "array" - items: - type: "object" - properties: - "role": - type: "string" - enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - anyOf: - - type: "string" - - type: "array" + - "type" + - "experiment_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_run" + "experiment_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "experiment_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "test_case_run" + "test_case_run_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_run_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "experiment_test_case" + "test_case_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "test_case_id" + - type: "object" + properties: + "type": + type: "string" + enum: + - "account" + "account_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + required: + - "type" + - "account_id" + description: "Define the internal account of the system. Also sometimes called user (internal)" + "data": + type: "object" + properties: + "choices": + type: "array" items: - oneOf: - - type: "object" - properties: - "type": - type: "string" - enum: - - "text" - "text": - type: "string" - required: - - "type" - - "text" - description: "Text content part of a prompt message" - - type: "object" - properties: - "type": - type: "string" - enum: - - "image_url" - "image_url": - type: "object" + type: "object" + properties: + "index": + type: "number" + "message": + anyOf: + - type: "object" properties: - "id": + "role": type: "string" - format: "ulid" - description: "The orq.ai id of the image" - readOnly: true + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + required: + - "role" + - "tool_calls" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + type: + - "string" + - "null" + required: + - "role" + - "content" + - type: "object" + properties: + "role": + type: "string" + enum: + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" "url": - anyOf: - - type: "string" - - type: "string" - format: "uri" - description: "Either a URL of the image or the base64 encoded data URI." - examples: - - "https://picsum.photos/id/1/200/300" - - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" - "detail": type: "string" - description: "Specifies the detail level of the image. Currently only supported with OpenAI models" required: + - "role" - "url" - required: - - "type" - - "image_url" - description: "The image part of the prompt message. Only supported with vision models." - description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " - "tool_calls": - type: "array" - items: - type: "object" - properties: - "id": - type: "string" - "index": - type: "number" - "type": - type: "string" - enum: - - "function" - "function": - type: "object" - properties: - "name": - type: "string" - "arguments": - type: "string" - description: "JSON string arguments for the functions" + "finish_reason": + type: + - "string" + - "null" required: - - "name" - - "arguments" - required: - - "type" - - "function" - required: - - "role" - - "content" - description: "A list of messages sent to the model." - "choices": - type: "array" - items: - type: "object" - properties: - "index": - type: "number" - "message": - anyOf: - - type: "object" + - "index" + "action": + type: "string" + enum: + - "invoke" + default: "invoke" + "integration_ids": + type: "array" + items: + type: "string" + "prompt_config": + type: "object" properties: - "role": + "stream": + type: "boolean" + "model": + type: "string" + "model_db_id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "model_type": type: "string" enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": - type: - - "string" - - "null" - "tool_calls": + - "chat" + - "completion" + - "embedding" + - "vision" + - "image" + - "tts" + - "stt" + - "rerank" + - "moderations" + description: "The type of the model" + "model_parameters": + type: "object" + properties: + "temperature": + type: "number" + description: "Only supported on `chat` and `completion` models." + "maxTokens": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topK": + type: "number" + description: "Only supported on `chat` and `completion` models." + "topP": + type: "number" + description: "Only supported on `chat` and `completion` models." + "frequencyPenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "presencePenalty": + type: "number" + description: "Only supported on `chat` and `completion` models." + "numImages": + type: "number" + description: "Only supported on `image` models." + "seed": + type: "number" + description: "Best effort deterministic seed for the model. Currently only OpenAI models support these" + "format": + type: "string" + enum: + - "url" + - "b64_json" + - "text" + - "json_object" + description: "Only supported on `image` models." + "dimensions": + type: "string" + description: "Only supported on `image` models." + "quality": + type: "string" + enum: + - "standard" + - "hd" + description: "Only supported on `image` models." + "style": + type: "string" + description: "Only supported on `image` models." + "responseFormat": + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_schema" + "json_schema": + type: "object" + properties: + "name": + type: "string" + "strict": + type: "boolean" + "schema": + type: "object" + additionalProperties: {} + required: + - "name" + - "strict" + - "schema" + required: + - "type" + - "json_schema" + - type: "object" + properties: + "type": + type: "string" + enum: + - "json_object" + required: + - "type" + - type: "null" + description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length." + "photoRealVersion": + type: "string" + enum: + - "v1" + - "v2" + description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider" + "encoding_format": + type: "string" + enum: + - "float" + - "base64" + description: "The format to return the embeddings" + description: "Model Parameters: Not all parameters apply to every model" + "provider": + type: "string" + enum: + - "cohere" + - "openai" + - "anthropic" + - "huggingface" + - "replicate" + - "google" + - "google-ai" + - "azure" + - "aws" + - "anyscale" + - "perplexity" + - "groq" + - "fal" + - "leonardoai" + - "nvidia" + - "jina" + "messages": type: "array" items: type: "object" properties: - "id": - type: "string" - "index": - type: "number" - "type": + "role": type: "string" enum: - - "function" - "function": - type: "object" - properties: - "name": - type: "string" - "arguments": - type: "string" - description: "JSON string arguments for the functions" - required: - - "name" - - "arguments" + - "system" + - "assistant" + - "user" + - "exception" + - "tool" + - "prompt" + - "correction" + - "expected_output" + description: "The role of the prompt message" + "content": + anyOf: + - type: "string" + - type: "array" + items: + oneOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "text" + "text": + type: "string" + required: + - "type" + - "text" + description: "Text content part of a prompt message" + - type: "object" + properties: + "type": + type: "string" + enum: + - "image_url" + "image_url": + type: "object" + properties: + "id": + type: "string" + format: "ulid" + description: "The orq.ai id of the image" + readOnly: true + "url": + anyOf: + - type: "string" + - type: "string" + format: "uri" + description: "Either a URL of the image or the base64 encoded data URI." + examples: + - "https://picsum.photos/id/1/200/300" + - "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z" + "detail": + type: "string" + description: "Specifies the detail level of the image. Currently only supported with OpenAI models" + required: + - "url" + required: + - "type" + - "image_url" + description: "The image part of the prompt message. Only supported with vision models." + description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. " + "tool_calls": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + "index": + type: "number" + "type": + type: "string" + enum: + - "function" + "function": + type: "object" + properties: + "name": + type: "string" + "arguments": + type: "string" + description: "JSON string arguments for the functions" + required: + - "name" + - "arguments" + required: + - "type" + - "function" + "id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true required: - - "type" - - "function" + - "role" + - "content" + "integration_id": + type: + - "string" + - "null" + format: "uuid" + description: "The id of the resource" + readOnly: true + "version": + type: "string" required: - - "role" - - "tool_calls" - - type: "object" + - "stream" + - "model" + - "model_db_id" + - "model_type" + - "model_parameters" + - "provider" + - "messages" + "variables": + type: "array" + items: + type: "object" + properties: + "key": + type: "string" + "value": {} + "is_pii": + type: "boolean" + default: false + required: + - "key" + "performance": + type: "object" properties: - "role": - type: "string" - enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "content": + "latency": + type: "number" + "first_time_to_token": type: - - "string" + - "number" + - "null" + "tokens_per_second": + type: + - "number" - "null" required: - - "role" - - "content" - - type: "object" + - "latency" + "usage": + type: "object" properties: - "role": - type: "string" - enum: - - "system" - - "assistant" - - "user" - - "exception" - - "tool" - - "prompt" - - "correction" - - "expected_output" - description: "The role of the prompt message" - "url": - type: "string" + "total_tokens": + type: "number" + "prompt_tokens": + type: "number" + "completion_tokens": + type: "number" + "prompt_tokens_details": + type: "object" + properties: + "cached_tokens": + type: "number" + "completion_tokens_details": + type: "object" + properties: + "reasoning_tokens": + type: "number" + "billing": + type: "object" + properties: + "total_cost": + type: + - "number" + - "null" + "input_cost": + type: + - "number" + - "null" + "output_cost": + type: + - "number" + - "null" + "billable": + type: "boolean" required: - - "role" - - "url" - "finish_reason": - type: - - "string" - - "null" + - "billable" + "provider_response": {} + "retrievals": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + description: "Unique id of the knowledge base" + "documents": + type: "array" + items: + type: "object" + properties: + "id": + type: "string" + format: "uuid" + description: "The id of the resource" + readOnly: true + "text": + type: "string" + description: "Text content of the document" + "metadata": + type: "object" + properties: + "datasource_id": + type: "string" + description: "Unique identifier for the data source" + "chunk_id": + type: "string" + description: "Unique identifier for the chunk" + "file_name": + type: "string" + description: "Name of the uploaded file during the datasource creation." + "page_number": + type: + - "number" + - "null" + description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." + "file_type": + type: "string" + description: "Type of the uploaded file when the datasource was created." + required: + - "datasource_id" + - "chunk_id" + - "file_name" + - "file_type" + "score": + type: "number" + description: "The score of the document" + "rerank_score": + type: "number" + description: "The rerank score of the document" + required: + - "id" + - "text" + - "metadata" + - "score" + description: "The documents returned" + "knowledge_key": + type: "string" + description: "The key of the knowledge base" + "query": + type: "string" + description: "The query used to search the knowledge base" + required: + - "knowledge_id" + - "documents" + - "knowledge_key" + - "query" + "knowledge_bases": + type: "array" + items: + type: "object" + properties: + "knowledge_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "configuration": + anyOf: + - type: "object" + properties: + "type": + type: "string" + enum: + - "last_user_message" + required: + - "type" + - type: "object" + properties: + "type": + type: "string" + enum: + - "query" + "query": + type: "string" + required: + - "type" + - "query" + description: "Defines the configuration settings which can either be for a user message or a text entry." + required: + - "knowledge_id" + - "configuration" + "tools": + type: "array" + items: + type: "object" + properties: + "type": + type: "string" + enum: + - "function" + description: "The type of the tool. Currently, only `function` is supported." + "function": + type: "object" + properties: + "name": + type: "string" + description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + "description": + type: "string" + description: "A description of what the function does, used by the model to choose when and how to call the function." + "strict": + type: "boolean" + "parameters": + type: "object" + properties: + "type": + type: "string" + enum: + - "object" + "properties": + type: "object" + additionalProperties: {} + "required": + type: "array" + items: + type: "string" + "additionalProperties": + type: "boolean" + enum: + - false + required: + - "type" + - "properties" + description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list." + required: + - "name" + - "parameters" + required: + - "type" + - "function" + "prompt_snippets": + type: "array" + items: + type: "object" + properties: + "_id": + type: "string" + format: "ulid" + description: "The id of the resource" + readOnly: true + "key": + type: "string" + "value": + type: "string" + required: + - "_id" + - "key" + - "value" + required: + - "prompt_config" + - "variables" + - "prompt_snippets" required: - - "index" - description: "A list of completion choices. If you are using a `completion` model then you must provide the `completion content` with the chat completion format" - "feedback": - type: "object" - properties: - "score": - type: "integer" - minimum: 0 - maximum: 100 - description: "The feedback score. This allow you to come with specific logic on what a `score` number means" - required: - - "score" - description: "Feedback from the user on the completion" - responses: - "200": - description: "Successful operation" + - "_id" + - "workspace_id" + - "started_at" + - "evals" + - "product_type" + - "related_entities" + - "data" + description: "The schema for the experiment workflow run" + description: "The schema for a workflow run" + "400": + description: "Bad request - validation error" content: "application/json": schema: @@ -5088,200 +77901,63 @@ paths: properties: "code": type: "number" - description: "The status code of the request" - "success": - type: "boolean" - description: "Whether the request was successful" + description: "HTTP status code" + "error": + type: "string" + description: "Error message" + "source": + type: "string" + enum: + - "provider" + - "system" + description: "The source where the error came from" required: - "code" - - "success" - "400": - description: "Bad Request" - "401": - description: "Unauthorized." - "/v2/files": - post: - tags: - - "Files" - x-speakeasy-group: "files" - x-speakeasy-name-override: "upload" - operationId: "FileUpload" - summary: "Upload file" - description: "Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config)." - requestBody: - required: true - content: - "multipart/form-data": - schema: - type: "object" - properties: - "file": - type: "string" - description: "The file to be uploaded." - format: "binary" - "purpose": - type: "string" - enum: - - "retrieval" - default: "retrieval" - description: "The intended purpose of the uploaded file." - responses: - "200": - description: "File uploaded successfully" + - "error" + - "source" + "403": + description: "Authorization error" content: "application/json": schema: type: "object" properties: - "_id": - type: "string" - "object_name": - type: "string" - description: "path to the file in the storage" - "purpose": - type: "string" - enum: - - "retrieval" - description: "The intended purpose of the uploaded file." - "bytes": - type: "number" - "file_name": - type: "string" - "created": + "message": type: "string" - format: "date-time" - default: "2024-12-16T16:28:54.131Z" - description: "The date and time the resource was created" - readOnly: true required: - - "_id" - - "object_name" - - "purpose" - - "bytes" - - "file_name" - "400": - description: "Bad request" - "/v2/files/bulk": - post: - tags: - - "Files" - x-speakeasy-group: "files" - x-speakeasy-name-override: "bulkUpload" - operationId: "BulkFileUpload" - summary: "Bulk upload file" - description: "Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config)." - requestBody: - required: true - content: - "multipart/form-data": - schema: - type: "object" - properties: - "files": - type: "array" - items: - type: "string" - description: "The file to be uploaded." - format: "binary" - "purpose": - type: "string" - enum: - - "retrieval" - description: "The intended purpose of the uploaded file." - required: - - "files" - - "purpose" - responses: - "200": - description: "Bulk files uploaded successfully" + - "message" + "404": + description: "Workspace ID is not found on the request" content: "application/json": schema: - type: "array" - items: - type: "object" - properties: - "_id": - type: "string" - "object_name": - type: "string" - description: "path to the file in the storage" - "purpose": - type: "string" - enum: - - "retrieval" - description: "The intended purpose of the uploaded file." - "bytes": - type: "number" - "file_name": - type: "string" - "created": - type: "string" - format: "date-time" - default: "2024-12-16T16:28:54.131Z" - description: "The date and time the resource was created" - readOnly: true - required: - - "_id" - - "object_name" - - "purpose" - - "bytes" - - "file_name" - "400": - description: "Bad request" - "/v2/remoteconfigs": - post: - tags: - - "Remote Config" - x-speakeasy-name-override: "getConfig" - x-speakeasy-group: "remoteconfig" - operationId: "RemoteConfigsGetConfig" - summary: "Get Configurations" - requestBody: - content: - "application/json": - schema: - type: "object" - properties: - "key": - type: "string" - description: "Remote configuration key" - "context": - type: "object" - additionalProperties: {} - description: "Key-value pairs matching your data model, applied to each prompt key." - "metadata": - type: "object" - additionalProperties: {} - description: "Key-value pairs to attach to the log generated by this request." - required: - - "key" - responses: - "200": - description: "An individual remote config" + type: "object" + properties: + "message": + type: "string" + required: + - "message" + description: "Error message" + "500": + description: "Internal server error" content: "application/json": schema: type: "object" properties: - "type": + "code": + type: "number" + description: "HTTP status code" + "error": + type: "string" + description: "Error message" + "source": type: "string" enum: - - "boolean" - - "string" - - "integer" - - "decimal" - - "list" - - "json" - - "deployment" - "value": {} + - "provider" + - "system" + description: "The source where the error came from" required: - - "type" - "400": - description: "Bad request" - "401": - description: "Unauthorized" - "404": - description: "Remote config not found" - "500": - description: "Internal server error" + - "code" + - "error" + - "source" diff --git a/packages/orq-rc/.speakeasy/gen.yaml b/packages/orq-rc/.speakeasy/gen.yaml index e1989c8..4b04a35 100644 --- a/packages/orq-rc/.speakeasy/gen.yaml +++ b/packages/orq-rc/.speakeasy/gen.yaml @@ -13,7 +13,7 @@ generation: oAuth2ClientCredentialsEnabled: true oAuth2PasswordEnabled: false typescript: - version: 1.32.0-rc.5 + version: 1.32.0-rc.6 additionalDependencies: dependencies: {} devDependencies: {}