Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://climate.api.nvidia.com/v1
/chat/completions
Given a list of messages comprising a conversation, the model will return a response. Compatible with OpenAI. See https://platform.openai.com/docs/api-reference/chat/create
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatCompletionRequest"
}
}
},
"required": true
}
POST /chat/completions
/biology/mit/diffdock
Predict molecular docking
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MolecularDockingRequest"
}
}
},
"required": true
}
POST /biology/mit/diffdock
/biology/nvidia/esmfold
Call predict function of a model that does not use multiple sequence alignments for prediction
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProteinStructurePredictRequest"
}
}
},
"required": true
}
POST /biology/nvidia/esmfold
/biology/nvidia/molmim/generate
Samples novel molecules around the encoded input SMILES.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoleculeGenerationBody"
}
}
},
"required": true
}
POST /biology/nvidia/molmim/generate
/genomics/nvidia/deepvariant
Run parabricks universal_variant_calling
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UniversalVariantCallingBody"
}
}
},
"required": true
}
POST /genomics/nvidia/deepvariant
/genomics/nvidia/fq2bam
Submits the reads for alignment with Parabricks fq2bam.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fq2bamRequestBody"
}
}
},
"required": true
}
POST /genomics/nvidia/fq2bam
/genai/stabilityai/sdxl-turbo
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageRequest"
}
}
},
"required": true
}
POST /genai/stabilityai/sdxl-turbo
/genai/stabilityai/stable-diffusion-xl
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageRequest"
}
}
},
"required": true
}
POST /genai/stabilityai/stable-diffusion-xl
/genai/stabilityai/stable-video-diffusion
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VideoRequest"
}
}
},
"required": true
}
POST /genai/stabilityai/stable-video-diffusion
/medicalimaging/nvidia/vista-3d
Run Inference function of a model for segmenting and annotating human anatomies
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InferenceRequest"
}
}
},
"required": true
}
POST /medicalimaging/nvidia/vista-3d
/vlm/adept/fuyu-8b
Invokes inference using the model chat parameters. If uploading large images, this POST should be used in conjunction with the NVCF API which allows for the upload of large assets. You can find details on how to use NVCF Asset APIs here: https://docs.api.nvidia.com/cloud-functions/reference/createasset
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| NVCF-INPUT-ASSET-REFERENCES | header | optional | string | String of asset IDs separated by commas. Data is uploaded to AWS S3 using NVCF Asset APIs and associated with these asset IDs.If the size of an image is more than 200KB, it needs to be uploaded to a presigned S3 URL bucket. The presigned URL allows for secure and temporary access to the S3 bucket for uploading the image. Once the asset is requested, an asset ID is generated for it. Please include this asset ID in this header and to use the uploaded image in a prompt, you need to refer to it using the following format: `<img src="data:image/png;asset_id,{asset_id}" />`. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatRequest"
}
}
},
"required": true
}
POST /vlm/adept/fuyu-8b
/vlm/google/deplot
Invokes inference using the model chat parameters. If uploading large images, this POST should be used in conjunction with the NVCF API which allows for the upload of large assets. You can find details on how to use NVCF Asset APIs here: https://docs.api.nvidia.com/cloud-functions/reference/createasset
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| NVCF-INPUT-ASSET-REFERENCES | header | optional | string | String of asset IDs separated by commas. Data is uploaded to AWS S3 using NVCF Asset APIs and associated with these asset IDs.If the size of an image is more than 200KB, it needs to be uploaded to a presigned S3 URL bucket. The presigned URL allows for secure and temporary access to the S3 bucket for uploading the image. Once the asset is requested, an asset ID is generated for it. Please include this asset ID in this header and to use the uploaded image in a prompt, you need to refer to it using the following format: `<img src="data:image/png;asset_id,{asset_id}" />`. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatRequest"
}
}
},
"required": true
}
POST /vlm/google/deplot
/vlm/microsoft/kosmos-2
Invokes inference using the model chat parameters. If uploading large images, this POST should be used in conjunction with the NVCF API which allows for the upload of large assets. You can find details on how to use NVCF Asset APIs here: https://docs.api.nvidia.com/cloud-functions/reference/createasset
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| NVCF-INPUT-ASSET-REFERENCES | header | optional | string | String of asset IDs separated by commas. Data is uploaded to AWS S3 using NVCF Asset APIs and associated with these asset IDs.If the size of an image is more than 200KB, it needs to be uploaded to a presigned S3 URL bucket. The presigned URL allows for secure and temporary access to the S3 bucket for uploading the image. Once the asset is requested, an asset ID is generated for it. Please include this asset ID in this header and to use the uploaded image in a prompt, you need to refer to it using the following format: `<img src="data:image/png;asset_id,{asset_id}" />`. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatRequest"
}
}
},
"required": true
}
POST /vlm/microsoft/kosmos-2
/vlm/nvidia/neva-22b
Invokes inference using the model chat parameters. If uploading large images, this POST should be used in conjunction with the NVCF API which allows for the upload of large assets. You can find details on how to use NVCF Asset APIs here: https://docs.api.nvidia.com/cloud-functions/reference/createasset
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| NVCF-INPUT-ASSET-REFERENCES | header | optional | string | String of asset IDs separated by commas. Data is uploaded to AWS S3 using NVCF Asset APIs and associated with these asset IDs.If the size of an image is more than 200KB, it needs to be uploaded to a presigned S3 URL bucket. The presigned URL allows for secure and temporary access to the S3 bucket for uploading the image. Once the asset is requested, an asset ID is generated for it. Please include this asset ID in this header and to use the uploaded image in a prompt, you need to refer to it using the following format: `<img src="data:image/png;asset_id,{asset_id}" />`. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatRequest"
}
}
},
"required": true
}
POST /vlm/nvidia/neva-22b
/nvidia/cuopt
Note: This is for managed service. Takes all the data and options at once, solves the routing problem and returns result. This POST should be used in conjunction with the NVCF API which allows for the upload of large assets. You can find details on how to use NVCF Asset APIs here: https://docs.api.nvidia.com/cloud-functions/reference/createasset
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| NVCF-INPUT-ASSET-REFERENCES | header | optional | string | String of asset IDs separated by commas. Data is uploaded to AWS S3 using NVCF Asset APIs and associated with these asset IDs.If the size of the json is more than 200KB, it needs to be uploaded to a presigned S3 URL bucket. The presigned URL allows for secure and temporary access to the S3 bucket for uploading the image. Once the asset is requested, an asset ID is generated for it. Please include this asset ID in this header and to use the uploaded json the 'data' field in the request body should be null; otherwise, it will be ignored. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CuOptApiManagedServiceEndpointRequest"
}
}
},
"required": true
}
POST /nvidia/cuopt
/nvidia/ai-weather-forecasting
Submits an inference configuration file to the server.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Config"
}
}
},
"required": true
}
POST /nvidia/ai-weather-forecasting
/retrieval/nvidia/embeddings
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEmbeddingRequest"
}
}
},
"required": true
}
POST /retrieval/nvidia/embeddings
/retrieval/nvidia/reranking
Order a list of passages by their relation to a query. Note that if a given query + passage pair is longer than the ranking model's context window, it will be automatically truncated.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RankRequest"
}
}
},
"required": true
}
POST /retrieval/nvidia/reranking
Artifact
{
"type": "object",
"title": "Artifact",
"required": [
"base64",
"finishReason",
"seed"
],
"properties": {
"seed": {
"type": "integer",
"title": "Seed",
"description": "The seed used during generation"
},
"base64": {
"type": "string",
"title": "Base64",
"example": "/9j/4AAQSkZ...b+AVZ/9k=",
"x-examples": [
"/9j/4AAQSkZ...b+AVZ/9k="
],
"description": "A base64-encoded string of the generated image (JPEG)"
},
"finishReason": {
"$ref": "#/components/schemas/FinishReason"
}
},
"x-konfig-properties": {
"finishReason": {
"description": "The result of the generation process. `SUCCESS` indicates success. `ERROR` indicates an error. `CONTENT_FILTERED` indicates the result affected by the content filter"
}
}
}
BredVector
{
"type": "object",
"title": "BredVector",
"properties": {
"type": {
"const": "BredVector",
"title": "Type",
"default": "BredVector"
},
"noise_amplitude": {
"type": "number",
"title": "Noise Amplitude",
"default": 0.05
},
"ensemble_perturb": {
"type": "boolean",
"title": "Ensemble Perturb",
"default": false
},
"integration_steps": {
"type": "integer",
"title": "Integration Steps",
"format": "int32",
"default": 20,
"maximum": 40,
"minimum": 1
}
},
"description": "Bred Vector class containing perturbation parameters.\n\nParameters\n----------\nnoise_amplitude : float = 0.05\n Noise amplitude\nintegration_steps : int = 20\n Number of integration steps to use in forward call.\nensemble_perturb : bool = False\n Whether to perturb the ensemble in an interacting fashion."
}
BrownNoise
{
"type": "object",
"title": "BrownNoise",
"properties": {
"type": {
"const": "BrownNoise",
"title": "Type",
"default": "BrownNoise"
},
"reddening": {
"type": "integer",
"title": "Reddening",
"format": "int32",
"default": 2,
"maximum": 10,
"minimum": 1
},
"noise_amplitude": {
"type": "number",
"title": "Noise Amplitude",
"default": 0.05
}
},
"description": "Brown Noise class containing perturbation parameters.\n\nParameters\n----------\nreddening : int = 2\n Reddening in Fourier space.\nnoise_amplitude : float = 0.05\n Noise amplitude."
}
ChannelAdjust
{
"type": "object",
"title": "ChannelAdjust",
"properties": {
"type": {
"const": "ChannelAdjust",
"title": "Type",
"default": "ChannelAdjust"
},
"noise_amplitude": {
"type": "number",
"title": "Noise Amplitude",
"default": 0
},
"delta_water_vapor": {
"type": "number",
"title": "Delta Water Vapor",
"default": 0
},
"delta_surface_wind_speed": {
"type": "number",
"title": "Delta Surface Wind Speed",
"default": 0
},
"delta_surface_temperature": {
"type": "number",
"title": "Delta Surface Temperature",
"default": 0
},
"delta_equator_pole_temperature_gradient": {
"type": "number",
"title": "Delta Equator Pole Temperature Gradient",
"default": 0
}
},
"description": "Perturbation method to relatively adjust certain channels.\n\nParameters\n----------\ndelta_surface_temperature: float\n (signed) % of global average temperature to adjust t2m.\ndelta_surface_wind_speed: float\n (signed) % of temperature standard deviation to adjust u10m and v10m.\ndelta_water_vapor: float\n (signed) % of temperature standard deviation to adjust tcwv.\ndelta_equator_pole_temperature_gradient: float\n (signed) % of temperature standard deviation to adjust temperature gradient\n for temperature at each geopotential height."
}
ChatCompletion
{
"type": "object",
"title": "ChatCompletion",
"required": [
"id",
"choices",
"usage"
],
"properties": {
"id": {
"type": "string",
"title": "Id",
"format": "uuid",
"maxLength": 36,
"description": "A unique identifier for the completion."
},
"usage": {
"$ref": "#/components/schemas/Usage"
},
"choices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Choice"
},
"title": "Choices",
"maxItems": 1,
"description": "The list of completion choices the model generated for the input prompt."
}
},
"x-konfig-properties": {
"usage": {
"description": "Usage statistics for the completion request."
}
}
}
ChatCompletionChunk
{
"type": "object",
"title": "ChatCompletionChunk",
"required": [
"id",
"choices"
],
"properties": {
"id": {
"type": "string",
"title": "Id",
"format": "uuid",
"maxLength": 36,
"description": "A unique identifier for the completion."
},
"choices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChoiceChunk"
},
"title": "Choices",
"maxItems": 1,
"description": "The list of completion choices the model generated for the input prompt."
}
}
}
ChatCompletionRequest
{
"type": "object",
"title": "ChatCompletionRequest",
"required": [
"messages"
],
"properties": {
"seed": {
"type": "null",
"title": "Seed",
"default": 0,
"description": "The model generates random results. Changing the input seed alone will produce a different response with similar characteristics. It is possible to reproduce results by fixing the input seed (assuming all other hyperparameters are also fixed)."
},
"stop": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
],
"title": "Stop",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "A string or a list of strings where the API will stop generating further tokens. The returned text will not contain the stop sequence."
},
"model": {
"type": "string",
"title": "Model",
"default": "mistralai/mixtral-8x7b-instruct-v0.1"
},
"top_p": {
"type": "number",
"title": "Top P",
"default": 1,
"maximum": 1,
"minimum": 0,
"description": "The top-p sampling mass used for text generation. The top-p value determines the probability mass that is sampled at sampling time. For example, if top_p = 0.2, only the most likely tokens (summing to 0.2 cumulative probability) will be sampled. It is not recommended to modify both temperature and top_p in the same call."
},
"stream": {
"type": "boolean",
"title": "Stream",
"default": false,
"description": "If set, partial message deltas will be sent. Tokens will be sent as data-only server-sent events (SSE) as they become available (JSON responses are prefixed by `data: `), with the stream terminated by a `data: [DONE]` message."
},
"messages": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
],
"title": "Messages",
"description": "A list of messages comprising the conversation so far."
},
"max_tokens": {
"type": "integer",
"title": "Max Tokens",
"default": 1024,
"minimum": 1,
"description": "The maximum number of tokens to generate in any given call. Note that the model is not aware of this value, and generation will simply stop at the number of tokens specified."
},
"temperature": {
"type": "number",
"title": "Temperature",
"default": 0.3,
"maximum": 1,
"minimum": 0,
"description": "The sampling temperature to use for text generation. The higher the temperature value is, the less deterministic the output text will be. It is not recommended to modify both temperature and top_p in the same call."
},
"presence_penalty": {
"type": "number",
"title": "Presence Penalty",
"default": 0,
"maximum": 2,
"minimum": -2,
"description": "Positive values penalize new tokens based on whether they appear in the text so far, increasing model likelihood to talk about new topics."
},
"frequency_penalty": {
"type": "number",
"title": "Frequency Penalty",
"default": 0,
"maximum": 2,
"minimum": -2,
"description": "Indicates how much to penalize new tokens based on their existing frequency in the text so far, decreasing model likelihood to repeat the same line verbatim."
}
},
"description": "OpenAI ChatCompletionRequest"
}
ChatCompletionResponse
{
"type": "object",
"title": "ChatCompletionResponse",
"required": [
"model",
"choices",
"usage"
],
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "A unique identifier for the completion."
},
"model": {
"type": "string",
"title": "Model",
"example": "mistralai/mixtral-8x7b-instruct-v0.1"
},
"usage": {
"$ref": "#/components/schemas/UsageInfo",
"description": "Usage statistics for the completion request."
},
"object": {
"type": "string",
"title": "Object",
"default": "chat.completion"
},
"choices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatCompletionResponseChoice"
},
"title": "Choices",
"description": "The list of completion choices the model generated for the input prompt."
},
"created": {
"type": "integer",
"title": "Created"
}
}
}
ChatCompletionResponseChoice
{
"type": "object",
"title": "ChatCompletionResponseChoice",
"required": [
"index",
"message"
],
"properties": {
"index": {
"type": "integer",
"title": "Index",
"description": "The index of the choice in the list of choices (always 0)."
},
"message": {
"$ref": "#/components/schemas/ChatMessage",
"description": "A chat completion message generated by the model."
},
"finish_reason": {
"enum": [
"stop",
"length"
],
"type": "string",
"title": "Finish Reason",
"nullable": true,
"description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, or `length` if the maximum number of tokens specified in the request was reached. Will be `null` if the model has not finished"
}
}
}
ChatGenerateModelResponseResponse
{
"type": "object",
"example": {},
"properties": {}
}
ChatMessage
{
"type": "object",
"title": "ChatMessage",
"required": [
"role",
"content"
],
"properties": {
"role": {
"type": "string",
"title": "Role",
"description": "The role of the message author."
},
"content": {
"type": "string",
"title": "Content",
"description": "The contents of the message."
}
}
}
ChatRequest
{
"type": "object",
"title": "ChatRequest",
"required": [
"messages"
],
"properties": {
"seed": {
"type": "integer",
"title": "Seed",
"default": null,
"example": 42,
"maximum": 18446744073709552000,
"minimum": 0,
"nullable": true,
"x-examples": [
42
],
"description": "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result."
},
"task": {
"enum": [
"VQA",
"image captioning"
],
"type": "string",
"title": "Task",
"default": "VQA",
"nullable": true,
"description": "Model is capable of performing two tasks: Visual Question Answering (VQA) and image captioning. \n<br>Visual Question Answering involves answering questions about an image. Image captioning, on the other hand, \n<br>generates descriptive captions for images. In image captioning both content and entities are ignored"
},
"model": {
"type": "string",
"title": "Model",
"default": "google/recurrentgemma-2b"
},
"top_p": {
"type": "number",
"title": "Top P",
"default": 0.7,
"maximum": 1,
"minimum": 0,
"description": "The top-p sampling mass used for text generation. The top-p value determines the probability mass that is sampled at sampling time. For example, if top_p = 0.2, only the most likely tokens (summing to 0.2 cumulative probability) will be sampled. It is not recommended to modify both temperature and top_p in the same call.",
"exclusiveMinimum": 0
},
"stream": {
"type": "boolean",
"title": "Stream",
"default": false,
"description": "If set, partial message deltas will be sent. Tokens will be sent as data-only server-sent events (SSE) as they become available (JSON responses are prefixed by `data: `), with the stream terminated by a `data: [DONE]` message."
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Message",
"anyOf": [
{
"$ref": "#/components/schemas/Message"
},
{
"$ref": "#/components/schemas/MessageWithEntities"
}
]
},
"title": "Messages",
"example": [
{
"name": null,
"role": "user",
"content": "Hi! What is in this image? <img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII==\" />"
}
],
"maxItems": 1,
"minItems": 1,
"x-examples": [
[
{
"name": null,
"role": "user",
"content": "Hi! What is in this image? <img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII==\" />"
}
],
[
{
"name": null,
"role": "user",
"content": "Hi! What is in this image? <img src=\"data:image/png;asset_id,87b132b0-08f9-43ea-8fab-f107350a5d00\" />"
}
]
],
"description": "A list of messages comprising the conversation so far. The roles of the messages must be alternating between `user` and `assistant`. The last input message should have role `user` or `assistant`. A message with the `system` role is optional, and must be the very first message if it is present."
},
"max_tokens": {
"type": "integer",
"title": "Max Tokens",
"default": 1024,
"maximum": 1024,
"minimum": 1,
"description": "The maximum number of tokens to generate in any given call. Note that the model is not aware of this value, and generation will simply stop at the number of tokens specified."
},
"temperature": {
"type": "number",
"title": "Temperature",
"default": 0.2,
"maximum": 1,
"minimum": 0,
"description": "The sampling temperature to use for text generation. The higher the temperature value is, the less deterministic the output text will be. It is not recommended to modify both temperature and top_p in the same call.",
"exclusiveMinimum": 0
},
"response_mode": {
"enum": [
"brief",
"detailed"
],
"type": "string",
"title": "Response Mode",
"default": "detailed",
"nullable": true,
"description": "These modes determine the level of information provided in the response. \n<br>When it is set `detailed` response will have a bit more information"
},
"bounding_boxes": {
"type": "boolean",
"title": "Bounding Boxes",
"default": null,
"nullable": true,
"deprecated": true,
"description": "[Deprecated parameter]: use `grounded_response` instead"
},
"grounded_response": {
"type": "boolean",
"title": "Grounded Response",
"default": true,
"description": "Grounding refers to the process of connecting or associating text with the visual world by \n<br>perceiving object descriptions, such as bounding boxes, within an image. So if set, the model will produce \n<br>bounding boxes for entities mentioned in the generated text."
}
}
}
Choice
{
"type": "object",
"title": "Choice",
"required": [
"message"
],
"properties": {
"index": {
"type": "integer",
"title": "Index",
"default": 0,
"minimum": 0,
"description": "The index of the choice in the list of choices (always 0).",
"exclusiveMaximum": 1
},
"message": {
"$ref": "#/components/schemas/Message"
},
"finish_reason": {
"enum": [
"stop",
"length"
],
"type": "string",
"title": "Finish Reason",
"default": null,
"example": "stop",
"nullable": true,
"x-examples": [
"stop"
],
"description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, or `length` if the maximum number of tokens specified in the request was reached."
}
},
"x-konfig-properties": {
"message": {
"anyOf": [
{
"$ref": "#/components/schemas/Message"
},
{
"$ref": "#/components/schemas/MessageWithEntities"
}
],
"title": "Message",
"example": {
"name": null,
"role": "assistant",
"content": "The image features a gray and white checkered pattern on a white background."
},
"x-examples": [
{
"name": null,
"role": "assistant",
"content": "The image features a gray and white checkered pattern on a white background."
}
],
"description": "A chat completion message generated by the model."
}
}
}
ChoiceChunk
{
"type": "object",
"title": "ChoiceChunk",
"required": [
"delta"
],
"properties": {
"delta": {
"$ref": "#/components/schemas/Message"
},
"index": {
"type": "integer",
"title": "Index",
"default": 0,
"minimum": 0,
"description": "The index of the choice in the list of choices (always 0).",
"exclusiveMaximum": 1
},
"finish_reason": {
"enum": [
"stop",
"length"
],
"type": "string",
"title": "Finish Reason",
"default": null,
"nullable": true,
"description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, or `length` if the maximum number of tokens specified in the request was reached. Will be `null` if the model has not finished generating."
}
},
"x-konfig-properties": {
"delta": {
"example": {
"name": null,
"role": "assistant",
"content": "The"
},
"x-examples": [
{
"name": null,
"role": "assistant",
"content": "The"
}
],
"description": "A chat completion delta generated by streamed model responses."
}
}
}
Config
{
"type": "object",
"title": "GenericConfig[SimulationParameters]",
"required": [
"parameters"
],
"properties": {
"outputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Output"
},
"title": "Outputs",
"default": [
{
"domain": {
"name": "global",
"type": "Window",
"lat_max": 90,
"lat_min": -90,
"lon_max": 360,
"lon_min": 0
},
"diagnostics": [
{
"type": "control",
"channels": [],
"function": [],
"properties": {}
}
]
}
],
"maxItems": 10,
"minItems": 1
},
"parameters": {
"$ref": "#/components/schemas/SimulationParameters"
}
}
}
ControlGenerationAlgo
{
"enum": [
"CMA-ES",
"none"
],
"type": "string",
"title": "ControlGenerationAlgo"
}
ControlGenerationProp
{
"enum": [
"QED",
"plogP"
],
"type": "string",
"title": "ControlGenerationProp"
}
CreateEmbedding400Response
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"detail": {
"type": "object",
"additionalProperties": true
},
"object": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
CreateEmbeddingRequest
{
"type": "object",
"required": [
"input",
"model"
],
"properties": {
"user": {
"type": "string",
"description": "Not implemented, but provided for API compliance. This field is ignored."
},
"input": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"maxLength": 4096,
"minLength": 1,
"description": "Input text to embed. Max length depends on model."
},
"model": {
"type": "string",
"example": "NV-Embed-QA",
"description": "ID of the embedding model."
},
"truncate": {
"enum": [
"NONE",
"START",
"END"
],
"type": "string",
"default": "NONE",
"description": "Specifies how inputs longer than the maximum token length of the model are handled. Passing `START` discards the start of the input. `END` discards the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. If `NONE` is selected, when the input exceeds the maximum input token length an error will be returned."
},
"input_type": {
"enum": [
"passage",
"query"
],
"type": "string",
"description": "NV-Embed-QA and E5 models operate in `passage` or `query` mode, and thus require the `input_type` parameter. `passage` is used when generating embeddings during indexing. `query` is used when generating embeddings during querying. It is very important to use the correct `input_type`. Failure to do so will result in large drops in retrieval accuracy. As an alternative, it is possible to add the `-query` or `-passage` suffix to the `model` parameter like `NV-Embed-QA-query` and not use the `input_type` field at all for OpenAI API compliance. Please note that the GTE model _does not_ accept the `input_type` parameter since both the query and passage are processed in the same way."
},
"encoding_format": {
"enum": [
"float",
"base64"
],
"type": "string",
"default": "float",
"description": "The format to return the embeddings in."
}
}
}
CreateEmbeddingResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmbeddingObject"
}
},
"model": {
"type": "string",
"example": "nre-001"
},
"usage": {
"type": "object",
"properties": {
"total_tokens": {
"type": "integer",
"example": 0
},
"prompt_tokens": {
"type": "integer",
"example": 0
}
},
"description": "Not implemented, but provided for API compliance. This field will contain zeros."
},
"object": {
"type": "string",
"example": "list"
}
}
}
CuOptApiFunctionResultGetResponse
{
"type": "object",
"example": {},
"properties": {}
}
CuOptApiManagedServiceEndpoint202Response
{
"type": "object",
"example": {},
"properties": {}
}
CuOptApiManagedServiceEndpoint400Response
{
"type": "object",
"title": "DetailModel",
"required": [
"detail"
],
"properties": {
"detail": {
"type": "string",
"title": "Detail",
"description": "Error details"
}
}
}
CuOptApiManagedServiceEndpoint409Response
{
"type": "object",
"title": "DetailModel",
"required": [
"detail"
],
"properties": {
"detail": {
"type": "string",
"title": "Detail",
"description": "Error details"
}
}
}
CuOptApiManagedServiceEndpoint422Response
{
"type": "object",
"title": "DetailModel",
"required": [
"detail"
],
"properties": {
"detail": {
"type": "string",
"title": "Detail",
"description": "Error details"
}
}
}
CuOptApiManagedServiceEndpoint500Response
{
"type": "object",
"title": "DetailModel",
"required": [
"detail"
],
"properties": {
"detail": {
"type": "string",
"title": "Detail",
"description": "Error details"
}
}
}
CuOptApiManagedServiceEndpointRequest
{
"type": "object",
"title": "cuoptData",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"title": "OptimizedRoutingData",
"nullable": true,
"required": [
"fleet_data",
"task_data"
],
"properties": {
"task_data": {
"allOf": [
{
"type": "object",
"title": "TaskData",
"required": [
"task_locations"
],
"properties": {
"demand": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
}
},
"title": "Demand",
"example": [
[
1,
1
],
[
3,
1
]
],
"nullable": true,
"x-examples": [
[
[
1,
1
],
[
3,
1
]
]
],
"description": "dtype: int32 \n\n Note: For this release number of demand dimensions are limited to 3. \n\n Lists of demands of each tasks.\nMultiple demands can be added and each list represents one kind of demand. Order of these demands should match the type of vehicle capacities provided.Example: In case of two sets of demands per vehicle with 3 vehicles, \n\n [ \n\n [dem_1_tsk_1, dem_1_tsk_2, dem_1_tsk_3], \n\n [dem_2_tsk_1, dem_2_tsk_2, dem_2_tsk_3] \n\n ]"
},
"prizes": {
"type": "array",
"items": {
"type": "number"
},
"title": "Prizes",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "dtype: float32, prizes >= 0. \n\n List of values which signifies prizes that are collected for fulfilling each task. This can be used effectively in case solution is infeasible and need to drop few tasks to get feasible solution. Solver will prioritize for higher prize tasks "
},
"task_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Task Ids",
"example": [
"Task-A",
"Task-B"
],
"nullable": true,
"x-examples": [
[
"Task-A",
"Task-B"
]
],
"description": "List of the task ids or names provided as a string."
},
"service_times": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
}
},
{
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "integer"
}
}
}
],
"title": "Service Times",
"example": [
0,
0
],
"nullable": true,
"x-examples": [
[
0,
0
]
],
"description": "dtype: int32, time >= 0. \n\n Service time for each task. Accepts a list of service times for all vehicles. In case of vehicle specific service times, accepts a dict with key as vehicle id and value as list of service times.Example schema: In case all vehicles have same service times, \n\n [tsk_1_srv_time, tsk_2_srv_time, tsk_3_srv_time] \n\n \n\n In case, there are 2 types of vehicle types and each of them have different service times, \n\n { \n\n type-1: [tsk_1_srv_time, tsk_3_srv_time, tsk_3_srv_time], \n\n type-2: [tsk_1_srv_time, tsk_3_srv_time, tsk_3_srv_time] \n\n }"
},
"task_locations": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Task Locations",
"example": [
1,
2
],
"x-examples": [
[
1,
2
]
],
"description": "dtype: int32, location >= 0. \n\n Location where the task has been requested."
},
"task_time_windows": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
}
},
"title": "Task Time Windows",
"example": [
[
0,
5
],
[
3,
9
]
],
"nullable": true,
"x-examples": [
[
[
0,
5
],
[
3,
9
]
]
],
"description": "dtype: int32, time >= 0. \n\n Earliest and Latest time windows for each tasks.\nFor example the data would look as follows, \n \n\n [ \n\n [tsk_1_earliest, tsk_1_latest], \n\n [tsk_2_earliest, tsk_2_latest] \n\n ]"
},
"mandatory_task_ids": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Mandatory Task Ids",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "dtype: int32, mandatory_task_id >= 0. \n\n Note: This is only effective when used along with drop infeasible option. \n\n A list of task ids which are mandatory and solver would fail if these cannot be fulfilled."
},
"order_vehicle_match": {
"type": "array",
"items": {
"type": "object",
"title": "OrderVehicleMatch",
"required": [
"order_id",
"vehicle_ids"
],
"properties": {
"order_id": {
"type": "integer",
"title": "Order Id",
"description": "dtype: int32, order_id >= 0. \n\n Indices of orders which can be served by this particular vehicleOrder id as an integer"
},
"vehicle_ids": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Vehicle Ids",
"description": "dtype: int32, vehicle_id >= 0. \n\n Indices of the vehicles which can serve this particular order. \n"
}
}
},
"title": "Order Vehicle Match",
"example": [
{
"order_id": 0,
"vehicle_ids": [
0
]
},
{
"order_id": 1,
"vehicle_ids": [
1
]
}
],
"nullable": true,
"x-examples": [
[
{
"order_id": 0,
"vehicle_ids": [
0
]
},
{
"order_id": 1,
"vehicle_ids": [
1
]
}
]
],
"description": "A list of order vehicle match, where the match would contain a order id and a list of vehicle ids that can serve this order."
},
"pickup_and_delivery_pairs": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
}
},
"title": "Pickup And Delivery Pairs",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "dtype: int32, pairs >= 0. \n\n List of Pick-up and delivery index pairs from task locations.\nIn case we have the following pick-up and delivery locations, 2->1, 4->5, 3->4, then task locations would look something like, task_locations = [0, 2, 1, 4, 5, 3, 4] and pick-up and delivery pairs would be index of those locations in task location and would look like [[1, 2], [3, 4], [5, 6]], 1 is pickup index for location 2 and it should be delivered to location 1 which is at index 2.Example schema: \n\n [ \n\n [pcikup_1_idx_to_task, drop_1_idx_to_task], \n\n [pcikup_2_idx_to_task, drop_2_idx_to_task], \n\n ]"
}
}
}
],
"description": "All Task information"
},
"fleet_data": {
"allOf": [
{
"type": "object",
"title": "FleetData",
"required": [
"vehicle_locations"
],
"properties": {
"capacities": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
}
},
"title": "Capacities",
"example": [
[
2,
2
],
[
4,
1
]
],
"nullable": true,
"x-examples": [
[
[
2,
2
],
[
4,
1
]
]
],
"description": "dtype: int32, capacity >= 0. \n\n Note: For this release number of capacity dimensions are limited to 3. \n\n Lists of capacities of each vehicle.\nMultiple capacities can be added and each list will represent one kind of capacity. Order of kind of the capacities should match order of the demands.\nTotal capacity for each type should be sufficient to complete all demand of that type.Example: In case of two sets of capacities per vehicle with 3 vehicles, \n\n [ \n\n [cap_1_veh_1, cap_1_veh_2, cap_1_veh_3], \n\n [cap_2_veh_1, cap_2_veh_2, cap_2_veh_3] \n\n ]"
},
"priorities": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Priorities",
"example": [
0,
1
],
"nullable": true,
"x-examples": [
[
0,
1
]
],
"description": "dtype: int32 \n\n Priorities of each vehicle, lower the value higher the priority, value should be within [0, 255]"
},
"vehicle_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Vehicle Ids",
"example": [
"veh-1",
"veh-2"
],
"nullable": true,
"x-examples": [
[
"veh-1",
"veh-2"
]
],
"description": "List of the vehicle ids or names provided as a string."
},
"min_vehicles": {
"type": "integer",
"title": "Min Vehicles",
"example": 2,
"nullable": true,
"x-examples": [
2
],
"description": "dtype: int32, min_vehicles >= 1. \n\n Solution should consider minimum number of vehicles"
},
"vehicle_types": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Vehicle Types",
"example": [
1,
2
],
"nullable": true,
"x-examples": [
[
1,
2
]
],
"description": "dtype: uint8. \n\n Types of vehicles in the fleet given as positive integers."
},
"skip_first_trips": {
"type": "array",
"items": {
"type": "boolean"
},
"title": "Skip First Trips",
"example": [
true,
false
],
"nullable": true,
"x-examples": [
[
true,
false
]
],
"description": "Drop the cost of trip to first location for that vehicle."
},
"drop_return_trips": {
"type": "array",
"items": {
"type": "boolean"
},
"title": "Drop Return Trips",
"example": [
true,
false
],
"nullable": true,
"x-examples": [
[
true,
false
]
],
"description": "Drop cost of return trip for each vehicle."
},
"vehicle_locations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
}
},
"title": "Vehicle Locations",
"example": [
[
0,
0
],
[
0,
0
]
],
"x-examples": [
[
[
0,
0
],
[
0,
0
]
]
],
"description": "dtype: int32, vehicle_location >= 0. \n\n Start and end location of the vehicles in the given set of locations in WayPointGraph or CostMatrices.\nExample: For 2 vehicles, \n\n [ \n\n [veh_1_start_loc, veh_1_end_loc], \n\n [veh_2_start_loc, veh_2_end_loc] \n\n ]"
},
"vehicle_max_costs": {
"type": "array",
"items": {
"type": "number"
},
"title": "Vehicle Max Costs",
"example": [
7,
10
],
"nullable": true,
"x-examples": [
[
7,
10
]
],
"description": "dtype: float32, max_costs >= 0. \n\n Maximum cost a vehicle can incur and it is based on cost matrix/cost waypoint graph."
},
"vehicle_max_times": {
"type": "array",
"items": {
"type": "number"
},
"title": "Vehicle Max Times",
"example": [
7,
10
],
"nullable": true,
"x-examples": [
[
7,
10
]
],
"description": "dtype: float32, max_time >= 0. \n\n Maximum time a vehicle can operate (includes drive, service and wait time), this is based on travel time matrix/travel time waypoint graph."
},
"vehicle_fixed_costs": {
"type": "array",
"items": {
"type": "number"
},
"title": "Vehicle Fixed Costs",
"example": [
15,
5
],
"nullable": true,
"x-examples": [
[
15,
5
]
],
"description": "dtype: float32, fixed_cost >= 0. \n\n Cost of each vehicle.This helps in routing where may be 2 vehicles with less cost is effective compared to 1 vehicle with huge cost. As example shows veh-0 (15) > veh-1 (5) + veh-2 (5)"
},
"vehicle_order_match": {
"type": "array",
"items": {
"type": "object",
"title": "VehicleOrderMatch",
"required": [
"vehicle_id",
"order_ids"
],
"properties": {
"order_ids": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Order Ids",
"description": "dtype: int32, order_id >= 0. \n\n Indices of orders which can be served by this particular vehicle"
},
"vehicle_id": {
"type": "integer",
"title": "Vehicle Id",
"description": "dtype: int32, vehicle_id >= 0. \n\n Vehicle id as an integer, and can serve all the order listed in order_ids."
}
}
},
"title": "Vehicle Order Match",
"example": [
{
"order_ids": [
0
],
"vehicle_id": 0
},
{
"order_ids": [
1
],
"vehicle_id": 1
}
],
"nullable": true,
"x-examples": [
[
{
"order_ids": [
0
],
"vehicle_id": 0
},
{
"order_ids": [
1
],
"vehicle_id": 1
}
]
],
"description": "A list of vehicle order match, where the match would contain a vehicle id and a list of orders that vehicle can serve."
},
"vehicle_time_windows": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
}
},
"title": "Vehicle Time Windows",
"example": [
[
0,
10
],
[
0,
10
]
],
"nullable": true,
"x-examples": [
[
[
0,
10
],
[
0,
10
]
]
],
"description": "dtype: int32, time >= 0. \n\n Earliest and Latest time window pairs for each vehicle,\nfor example the data would look as follows for 2 vehicles, \n \n\n [ \n\n [veh_1_earliest, veh_1_latest], \n\n [veh_2_earliest, veh_2_latest] \n\n ]"
},
"vehicle_break_durations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
}
},
"title": "Vehicle Break Durations",
"example": [
[
1,
1
]
],
"nullable": true,
"x-examples": [
[
[
1,
1
]
]
],
"description": "dtype: int32, time >= 0. \n\n Break duration for each vehicle. vehicle_break_time_windows should be provided to use this option.For example, in case of having 2 breaks for each vehicle, \n\n [ \n\n [brk_1_veh_1_duration, brk_1_veh_2_duration], \n\n [brk_2_veh_1_duration, brk_2_veh_2_duration], \n\n ]"
},
"vehicle_break_locations": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Vehicle Break Locations",
"example": [
0,
1
],
"nullable": true,
"x-examples": [
[
0,
1
]
],
"description": "dtype: int32, location >= 0. \n\n Break location where vehicles can take breaks. If not set, any location can be used for the break."
},
"vehicle_break_time_windows": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"title": "Vehicle Break Time Windows",
"example": [
[
[
1,
2
],
[
2,
3
]
]
],
"nullable": true,
"x-examples": [
[
[
[
1,
2
],
[
2,
3
]
]
]
],
"description": "dtype: int32, time >= 0. \n\n Multiple break time windows can be added for each vehicle.Earliest and Latest break time window pairs for each vehicle,\nFor example, in case of 2 sets of breaks for each vehicle which translates to 2 dimensions of breaks,\n \n\n [ \n\n [[brk_1_veh_1_earliest, brk_1_veh_1_latest], [brk_1_veh_2_earliest, brk_1_veh_2_latest]] \n\n [[brk_2_veh_1_earliest, brk_2_veh_1_latest], [brk_2_veh_2_earliest, brk_2_veh_2_latest]] \n\n ] \n\n The break duration within this time window is provided through vehicle_break_durations."
}
}
}
],
"description": "All Fleet information"
},
"solver_config": {
"type": "object",
"title": "UpdateSolverSettingsConfig",
"nullable": true,
"properties": {
"objectives": {
"type": "object",
"title": "Objective",
"nullable": true,
"properties": {
"cost": {
"type": "number",
"title": "Cost",
"example": 1,
"nullable": true,
"x-examples": [
1
],
"description": "dtype: float32. \n\n The weight assigned to minimizing the cost for a given solution, default value is 1"
},
"prize": {
"type": "number",
"title": "Prize",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the prize in accumulated prizes for each job fulfilled.This will be negated from overall values accumulated with other objectives.For example, if cost accumulated is 10 and objective value for it is 1, and if the prize accumulated is 3 and objective is 2, then total cost would look something like this 10 x 1 - 3 x 2 = 4."
},
"travel_time": {
"type": "number",
"title": "Travel Time",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to minimizing total travel time for a given solution (includes drive, service and wait time)"
},
"vehicle_fixed_cost": {
"type": "number",
"title": "Vehicle Fixed Cost",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the accumulated fixed costs of each vehicle used in solution"
},
"variance_route_size": {
"type": "number",
"title": "Variance Route Size",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the variance in the number of orders served by each route."
},
"variance_route_service_time": {
"type": "number",
"title": "Variance Route Service Time",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the variance in the accumulated service times of each route"
}
},
"description": "Values provided dictate the linear combination of factors used to evaluate solution quality.Only prize will be negated, all others gets accumulated. That's why sometime you might come across negative value as solution cost."
},
"time_limit": {
"type": "number",
"title": "Time Limit",
"example": 1,
"nullable": true,
"x-examples": [
1
],
"description": "SolverSettings time limit"
},
"config_file": {
"type": "string",
"title": "Config File",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "Dump configuration information in a given file as yaml"
},
"verbose_mode": {
"type": "boolean",
"title": "Verbose Mode",
"default": false,
"nullable": true,
"description": "Displaying internal information during the solver execution."
},
"error_logging": {
"type": "boolean",
"title": "Error Logging",
"default": true,
"nullable": true,
"description": "Displaying constraint error information during the solver execution."
},
"drop_infeasible_tasks": {
"type": "boolean",
"title": "Drop Infeasible Tasks",
"default": false,
"nullable": true,
"description": "Note: Prize collection is recommend for finer control over \n\n what tasks would be picked or dropped. Drops infeasible tasks and returns routes for only feasible tasks. This should be used when solver fails to find a solution to fulfill all the tasks/order, "
}
}
},
"cost_matrix_data": {
"type": "object",
"title": "UpdateCostMatrices",
"default": {},
"example": {
"cost_matrix": {
"1": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
1,
0
]
],
"2": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
2,
0
]
]
}
},
"nullable": true,
"properties": {
"data": {
"type": "object",
"title": "Data",
"nullable": true,
"description": "dtype : vehicle-type (uint8), cost (float32), cost >= 0.\n \n\n Sqaure matrix with cost to travel from A to B and B to A. \nIf there different types of vehicles which have different \ncost matrices, they can be provided with key value pair \nwhere key is vehicle-type and value is cost matrix. Value of \nvehicle type should be within [0, 255]",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
}
},
"cost_matrix": {
"type": "object",
"title": "Cost Matrix",
"nullable": true,
"deprecated": true,
"description": "This field is deprecated, please use the 'data' field instead",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
}
}
},
"x-examples": [
{
"cost_matrix": {
"1": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
1,
0
]
],
"2": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
2,
0
]
]
}
}
],
"description": "Sqaure matrix with cost to travel from A to B and B to A. \nIf there are different types of vehicles which have different \ncost matrices, they can be provided with key value pair \nwhere key is vehicle-type and value is cost matrix. Value of \nvehicle type should be within [0, 255]"
},
"travel_time_matrix_data": {
"type": "object",
"title": "UpdateCostMatrices",
"default": {},
"example": {
"cost_matrix": {
"1": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
1,
0
]
],
"2": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
2,
0
]
]
}
},
"nullable": true,
"properties": {
"data": {
"type": "object",
"title": "Data",
"nullable": true,
"description": "dtype : vehicle-type (uint8), cost (float32), cost >= 0.\n \n\n Sqaure matrix with cost to travel from A to B and B to A. \nIf there different types of vehicles which have different \ncost matrices, they can be provided with key value pair \nwhere key is vehicle-type and value is cost matrix. Value of \nvehicle type should be within [0, 255]",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
}
},
"cost_matrix": {
"type": "object",
"title": "Cost Matrix",
"nullable": true,
"deprecated": true,
"description": "This field is deprecated, please use the 'data' field instead",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
}
}
},
"x-examples": [
{
"cost_matrix": {
"1": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
1,
0
]
],
"2": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
2,
0
]
]
}
}
],
"description": "Sqaure matrix with time to travel from A to B and B to A. \nIf there are different types of vehicles which have different \ntravel time matrices, they can be provided with key value pair \nwhere key is vehicle-type and value is time matrix. Value of \nvehicle type should be within [0, 255]"
},
"cost_waypoint_graph_data": {
"type": "object",
"title": "UpdateWaypointGraphData",
"default": {},
"example": null,
"nullable": true,
"properties": {
"waypoint_graph": {
"type": "object",
"title": "Waypoint Graph",
"nullable": true,
"additionalProperties": {
"type": "object",
"title": "WaypointGraph",
"required": [
"edges",
"offsets"
],
"properties": {
"edges": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Edges",
"description": "dtype: int32, edge >= 0. \n\n Vertices of all the directed edges."
},
"offsets": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Offsets",
"description": "dtype: int32, offset >= 0. \n\n Offsets which provide number of edges from the source vertex signified by the index."
},
"weights": {
"type": "array",
"items": {
"type": "number"
},
"title": "Weights",
"nullable": true,
"description": "dtype: float32, weight >= 0. \n\n Weights of each edges."
}
}
}
}
},
"x-examples": [
null
],
"description": "Waypoint graph with weights as cost to travel from A to B \nand B to A. If there are different types of vehicles \nthey can be provided with key value pair \nwhere key is vehicle-type and value is the graph. Value of \nvehicle type should be within [0, 255]"
},
"travel_time_waypoint_graph_data": {
"type": "object",
"title": "UpdateWaypointGraphData",
"default": {},
"example": null,
"nullable": true,
"properties": {
"waypoint_graph": {
"type": "object",
"title": "Waypoint Graph",
"nullable": true,
"additionalProperties": {
"type": "object",
"title": "WaypointGraph",
"required": [
"edges",
"offsets"
],
"properties": {
"edges": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Edges",
"description": "dtype: int32, edge >= 0. \n\n Vertices of all the directed edges."
},
"offsets": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Offsets",
"description": "dtype: int32, offset >= 0. \n\n Offsets which provide number of edges from the source vertex signified by the index."
},
"weights": {
"type": "array",
"items": {
"type": "number"
},
"title": "Weights",
"nullable": true,
"description": "dtype: float32, weight >= 0. \n\n Weights of each edges."
}
}
}
}
},
"x-examples": [
null
],
"description": "Waypoint graph with weights as time to travel from A to B \nand B to A. If there are different types of vehicles \nthey can be provided with key value pair \nwhere key is vehicle-type and value is the graph. Value of \nvehicle type should be within [0, 255]"
}
},
"description": "The data that needs to be processed by the service. For detailed explanations of each field, please consult the following link: <a href=\"https://docs.nvidia.com/cuopt/service/latest/data-requirements.html\">data requirements</a> . To ensure best practices, please refer to: <a href=\"https://docs.nvidia.com/cuopt/service/latest/best-practices.html\">best practices</a>. For examples, you can find them at: <a href=\"https://github.com/NVIDIA/cuOpt-Resources/tree/branch-23.10/notebooks/routing/service\">notebooks</a>. If the size of the data exceeds 250KB, please utilize the large assets API to upload it to s3. In such cases, set the data as null and include the header NVCF-INPUT-ASSET-REFERENCES: $ASSET_ID in the POST request."
},
"action": {
"enum": [
"cuOpt_OptimizedRouting",
"cuOpt_RoutingValidator",
"0"
],
"type": "string",
"title": "Action",
"default": "cuOpt_OptimizedRouting",
"nullable": true,
"description": "Action to be performed by the service, validator action just validates input against format and base rules."
},
"parameters": {
"type": "object",
"title": "Parameters",
"nullable": true,
"description": "unused/ignored but retained for compatibility"
},
"client_version": {
"type": "string",
"title": "Client Version",
"default": "",
"nullable": true,
"description": "cuOpt client version. Set to 'custom' to skip version check."
}
}
}
CuOptApiManagedServiceEndpointResponse
{
"anyOf": [
{
"type": "object",
"title": "EmptyDict",
"properties": {}
},
{
"type": "object",
"title": "ResponseModel",
"required": [
"response"
],
"properties": {
"notes": {
"type": "array",
"items": {
"type": "string"
},
"title": "Notes",
"default": [],
"description": "Any notes for users"
},
"response": {
"anyOf": [
{
"type": "object",
"title": "FeasibleSolve",
"properties": {
"perf_times": {
"type": "object",
"title": "Perf Times",
"nullable": true,
"description": "Etl and Solve times of the solve call"
},
"solver_response": {
"allOf": [
{
"type": "object",
"title": "FeasibleResultData",
"properties": {
"msg": {
"type": "string",
"title": "Msg",
"default": "",
"nullable": true,
"description": "Any information pertaining to the run."
},
"status": {
"type": "integer",
"title": "Status",
"default": 0,
"example": 0,
"x-examples": [
0
],
"description": "0 - Solution is available \n1 - Infeasible solution is available \n"
},
"num_vehicles": {
"type": "integer",
"title": "Num Vehicles",
"default": -1,
"example": 2,
"x-examples": [
2
],
"description": "Number of vehicle being used for the solution"
},
"vehicle_data": {
"type": "object",
"title": "Vehicle Data",
"default": {},
"example": {
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
},
"x-examples": [
{
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
}
],
"description": "All the details of vehicle routes and timestamps",
"additionalProperties": {
"type": "object",
"title": "VehicleData",
"properties": {
"type": {
"type": "array",
"items": {
"enum": [
"Depot",
"Pickup",
"Delivery",
"Break",
"w"
],
"type": "string",
"title": "LocationTypeEnum"
},
"title": "Type",
"default": [],
"description": "Type of routing point, whether it is Depot, Waypoint - w \nDelivery, Break, Pickup \n"
},
"route": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Route",
"default": [],
"description": "Route indices as per waypoint graph or cost matrix provided"
},
"task_id": {
"type": "array",
"items": {
"type": "string"
},
"title": "Task Id",
"default": [],
"description": "task_ids being assigned to vehicle along with depot and breaks"
},
"arrival_stamp": {
"type": "array",
"items": {
"type": "number"
},
"title": "Arrival Stamp",
"default": [],
"description": "arrival stamps at each task locations"
}
}
}
},
"solution_cost": {
"type": "number",
"title": "Solution Cost",
"default": -1,
"example": 2,
"x-examples": [
2
],
"description": "Total cost of the solution"
}
}
}
],
"default": {
"msg": "",
"status": 0,
"num_vehicles": -1,
"vehicle_data": {},
"solution_cost": -1
},
"description": "Feasible solution"
}
}
},
{
"type": "object",
"title": "InFeasibleSolve",
"properties": {
"perf_times": {
"type": "object",
"title": "Perf Times",
"nullable": true,
"description": "Etl and Solve times of the solve call"
},
"solver_infeasible_response": {
"allOf": [
{
"type": "object",
"title": "InfeasibleResultData",
"properties": {
"msg": {
"type": "string",
"title": "Msg",
"default": "",
"nullable": true,
"description": "Any information pertaining to the run."
},
"status": {
"type": "integer",
"title": "Status",
"default": 1,
"example": 1,
"x-examples": [
1
],
"description": "1 - Infeasible solution is available \n"
},
"num_vehicles": {
"type": "integer",
"title": "Num Vehicles",
"default": -1,
"example": 2,
"x-examples": [
2
],
"description": "Number of vehicle being used for the solution"
},
"vehicle_data": {
"type": "object",
"title": "Vehicle Data",
"default": {},
"example": {
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
},
"x-examples": [
{
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
}
],
"description": "All the details of vehicle routes and timestamps",
"additionalProperties": {
"type": "object",
"title": "VehicleData",
"properties": {
"type": {
"type": "array",
"items": {
"enum": [
"Depot",
"Pickup",
"Delivery",
"Break",
"w"
],
"type": "string",
"title": "LocationTypeEnum"
},
"title": "Type",
"default": [],
"description": "Type of routing point, whether it is Depot, Waypoint - w \nDelivery, Break, Pickup \n"
},
"route": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Route",
"default": [],
"description": "Route indices as per waypoint graph or cost matrix provided"
},
"task_id": {
"type": "array",
"items": {
"type": "string"
},
"title": "Task Id",
"default": [],
"description": "task_ids being assigned to vehicle along with depot and breaks"
},
"arrival_stamp": {
"type": "array",
"items": {
"type": "number"
},
"title": "Arrival Stamp",
"default": [],
"description": "arrival stamps at each task locations"
}
}
}
},
"solution_cost": {
"type": "number",
"title": "Solution Cost",
"default": -1,
"example": 2,
"x-examples": [
2
],
"description": "Total cost of the solution"
}
}
}
],
"default": {
"msg": "",
"status": 1,
"num_vehicles": -1,
"vehicle_data": {},
"solution_cost": -1
},
"description": "Infeasible solution, this can mean the problem itself is infeasible or solver requires more time to find a solution. Setting default solve time is suggested in case you are not aware of the expected time."
}
}
}
],
"title": "Response",
"description": "Response"
},
"warnings": {
"type": "array",
"items": {
"type": "string"
},
"title": "Warnings",
"default": [],
"description": "List of warnings for users to handle issues"
}
}
}
],
"title": "Response Cuopt Cuopt Cuopt Post"
}
DefaultProteinStructurePredictionNoAlnResponse
{
"type": "object",
"example": {},
"properties": {}
}
DefaultRunParabricksUvcInferenceResponse
{
"type": "object",
"example": {},
"properties": {}
}
DetailModel
{
"type": "object",
"title": "DetailModel",
"required": [
"detail"
],
"properties": {
"detail": {
"type": "string",
"title": "Detail",
"description": "Error details"
}
}
}
Diagnostic
{
"type": "object",
"title": "Diagnostic",
"required": [
"type"
],
"properties": {
"type": {
"$ref": "#/components/schemas/DiagnosticTypes"
},
"channels": {
"type": "array",
"items": {
"type": "string",
"pattern": "[A-Za-z0-9]+",
"maxLength": 88
},
"title": "Channels",
"default": [],
"maxItems": 83
},
"function": {
"type": "array",
"items": {
"type": "string",
"pattern": "[a-z]+",
"maxLength": 88
},
"title": "Function",
"default": [],
"maxItems": 3
},
"properties": {
"type": "object",
"title": "Properties",
"default": {},
"maxProperties": 3
}
},
"description": "Diagnostic class defining the diagnostic, any functions applied to the\ndiagnostic, the channels of interest, and any diagnostic properties.\n\nParameters\n-----------\nfunction : List[str]\n Any functions applied to the diagnostic during\n post-processing.\nchannels : List[str]\n Channels to save diagnostics for, must be a subset\n of the model channel list.\nproperties : dict\n Diagnostic-specific properties."
}
DiagnosticTypes
{
"enum": [
"full_ensemble",
"control",
"histogram",
"ensemble_stats",
"kde",
"ensemble_svd",
"climatenet"
],
"type": "string",
"title": "DiagnosticTypes",
"description": "Diagnostic and Statistic Options."
}
EmbeddingFormat
{
"enum": [
"npz",
"h5"
],
"type": "string",
"title": "EmbeddingFormat"
}
EmbeddingFormatNullable
{
"enum": [
"npz",
"h5"
],
"type": "string",
"title": "Input format(npz|h5)",
"default": "npz",
"nullable": true,
"description": "Input format"
}
EmbeddingObject
{
"type": "object",
"required": [
"object",
"embedding",
"index"
],
"properties": {
"index": {
"type": "integer",
"description": "The index of the embedding in the list of embeddings."
},
"object": {
"type": "string",
"example": "embedding"
},
"embedding": {
"oneOf": [
{
"type": "array",
"items": {
"type": "number"
},
"description": "The embedding vector as a list of floats. The length of the vector depends on the model."
},
{
"type": "string",
"description": "The embedding vector as a Base64 string. The length of the string depends on the model."
}
]
}
}
}
EmptyDict
{
"type": "object",
"title": "EmptyDict",
"properties": {}
}
Entity
{
"type": "object",
"title": "Entity",
"required": [
"phrase",
"substring",
"bboxes"
],
"properties": {
"bboxes": {
"type": "array",
"items": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"maxItems": 4,
"minItems": 4,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
},
"title": "Bboxes",
"example": [
[
0.203125,
0.109375,
0.765625,
0.609375
]
],
"x-examples": [
[
[
0.203125,
0.109375,
0.765625,
0.609375
]
],
[
[
0.171875,
0.421875,
0.453125,
0.984375
],
[
0.609375,
0.421875,
0.796875,
0.984375
],
[
0.421875,
0.453125,
0.609375,
0.984375
],
[
0.203125,
0.171875,
0.390625,
0.578125
]
]
],
"description": "Bounding boxes are rectangle-shaped boxes that surround objects or areas of interest in an image. \n<br>They are used to identify and describe the entities in the image. These are defined using four values: \n<br>top left x, top left y, bottom right x, and bottom right y. The top left x and top left y values indicate \n<br>the normalized coordinates of the upper-left corner of the bounding box, while the bottom right x and bottom right y values \n<br>represent the normalized coordinates of the lower-right corner of the bounding box. "
},
"phrase": {
"type": "string",
"title": "Phrase",
"example": "The coach",
"x-examples": [
"The coach",
"young soccer players"
],
"description": "Term used to refer to the specific phrase mentioned in the text."
},
"substring": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"title": "Substring",
"example": [
0,
8
],
"maxItems": 2,
"minItems": 2,
"x-examples": [
[
0,
8
],
[
45,
64
]
],
"description": "Tuple of start and end indices that indicate the position of the entity term within the text. \n<br>These indices help identify the specific location of the entity term within the text. \n<br>The indices mentioned are zero-based, which means they start counting from zero. The both indices are inclusive,\n<br>meaning it is included in the range.",
"prefixItems": [
{
"type": "integer"
},
{
"type": "integer"
}
]
}
}
}
Errors
{
"type": "object",
"title": "InvokeError",
"required": [
"type",
"title",
"status",
"detail",
"instance",
"requestId"
],
"properties": {
"type": {
"type": "string",
"format": "^.{1, 128}$",
"maxLength": 128,
"description": "Error type"
},
"title": {
"type": "string",
"format": "^.{1, 128}$",
"maxLength": 128,
"description": "Error title"
},
"detail": {
"type": "string",
"format": "^.{1, 1024}$",
"maxLength": 1024,
"description": "Detailed information about the error"
},
"status": {
"type": "integer",
"maximum": 999,
"minimum": 100,
"description": "Error status code"
},
"instance": {
"type": "string",
"format": "^.{1, 256}$",
"maxLength": 256,
"description": "Function instance used to invoke the request"
},
"requestId": {
"type": "string",
"format": "uuid",
"maxLength": 36,
"description": "UUID of the request"
}
}
}
FeasibleResultData
{
"type": "object",
"title": "FeasibleResultData",
"properties": {
"msg": {
"type": "string",
"title": "Msg",
"default": "",
"nullable": true,
"description": "Any information pertaining to the run."
},
"status": {
"type": "integer",
"title": "Status",
"default": 0,
"example": 0,
"maximum": 0,
"minimum": 0,
"x-examples": [
0
],
"description": "0 - Solution is available \n1 - Infeasible solution is available \n"
},
"num_vehicles": {
"type": "integer",
"title": "Num Vehicles",
"default": -1,
"example": 2,
"maximum": 2147483647,
"minimum": 0,
"x-examples": [
2
],
"description": "Number of vehicle being used for the solution"
},
"vehicle_data": {
"type": "object",
"title": "Vehicle Data",
"default": {},
"example": {
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
},
"x-examples": [
{
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
}
],
"description": "All the details of vehicle routes and timestamps",
"additionalProperties": {
"type": "object",
"title": "VehicleData",
"properties": {
"type": {
"type": "array",
"items": {
"enum": [
"Depot",
"Pickup",
"Delivery",
"Break",
"w"
],
"type": "string",
"title": "LocationTypeEnum"
},
"title": "Type",
"default": [],
"description": "Type of routing point, whether it is Depot, Waypoint - w \nDelivery, Break, Pickup \n"
},
"route": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Route",
"default": [],
"description": "Route indices as per waypoint graph or cost matrix provided"
},
"task_id": {
"type": "array",
"items": {
"type": "string"
},
"title": "Task Id",
"default": [],
"description": "task_ids being assigned to vehicle along with depot and breaks"
},
"arrival_stamp": {
"type": "array",
"items": {
"type": "number"
},
"title": "Arrival Stamp",
"default": [],
"description": "arrival stamps at each task locations"
}
}
}
},
"solution_cost": {
"type": "number",
"title": "Solution Cost",
"default": -1,
"example": 2,
"x-examples": [
2
],
"description": "Total cost of the solution"
}
}
}
FeasibleSolve
{
"type": "object",
"title": "FeasibleSolve",
"properties": {
"perf_times": {
"type": "object",
"title": "Perf Times",
"nullable": true,
"description": "Etl and Solve times of the solve call"
},
"solver_response": {
"allOf": [
{
"type": "object",
"title": "FeasibleResultData",
"properties": {
"msg": {
"type": "string",
"title": "Msg",
"default": "",
"nullable": true,
"description": "Any information pertaining to the run."
},
"status": {
"type": "integer",
"title": "Status",
"default": 0,
"example": 0,
"maximum": 0,
"minimum": 0,
"x-examples": [
0
],
"description": "0 - Solution is available \n1 - Infeasible solution is available \n"
},
"num_vehicles": {
"type": "integer",
"title": "Num Vehicles",
"default": -1,
"example": 2,
"maximum": 2147483647,
"minimum": 0,
"x-examples": [
2
],
"description": "Number of vehicle being used for the solution"
},
"vehicle_data": {
"type": "object",
"title": "Vehicle Data",
"default": {},
"example": {
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
},
"x-examples": [
{
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
}
],
"description": "All the details of vehicle routes and timestamps",
"additionalProperties": {
"type": "object",
"title": "VehicleData",
"properties": {
"type": {
"type": "array",
"items": {
"enum": [
"Depot",
"Pickup",
"Delivery",
"Break",
"w"
],
"type": "string",
"title": "LocationTypeEnum"
},
"title": "Type",
"default": [],
"description": "Type of routing point, whether it is Depot, Waypoint - w \nDelivery, Break, Pickup \n"
},
"route": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Route",
"default": [],
"description": "Route indices as per waypoint graph or cost matrix provided"
},
"task_id": {
"type": "array",
"items": {
"type": "string"
},
"title": "Task Id",
"default": [],
"description": "task_ids being assigned to vehicle along with depot and breaks"
},
"arrival_stamp": {
"type": "array",
"items": {
"type": "number"
},
"title": "Arrival Stamp",
"default": [],
"description": "arrival stamps at each task locations"
}
}
}
},
"solution_cost": {
"type": "number",
"title": "Solution Cost",
"default": -1,
"example": 2,
"x-examples": [
2
],
"description": "Total cost of the solution"
}
}
}
],
"default": {
"msg": "",
"status": 0,
"num_vehicles": -1,
"vehicle_data": {},
"solution_cost": -1
},
"description": "Feasible solution"
}
}
}
FinishReason
{
"enum": [
"CONTENT_FILTERED",
"ERROR",
"SUCCESS"
],
"type": "string",
"title": "FinishReason"
}
FleetData
{
"type": "object",
"title": "FleetData",
"required": [
"vehicle_locations"
],
"properties": {
"capacities": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Capacities",
"example": [
[
2,
2
],
[
4,
1
]
],
"nullable": true,
"x-examples": [
[
[
2,
2
],
[
4,
1
]
]
],
"description": "dtype: int32, capacity >= 0. \n\n Note: For this release number of capacity dimensions are limited to 3. \n\n Lists of capacities of each vehicle.\nMultiple capacities can be added and each list will represent one kind of capacity. Order of kind of the capacities should match order of the demands.\nTotal capacity for each type should be sufficient to complete all demand of that type.Example: In case of two sets of capacities per vehicle with 3 vehicles, \n\n [ \n\n [cap_1_veh_1, cap_1_veh_2, cap_1_veh_3], \n\n [cap_2_veh_1, cap_2_veh_2, cap_2_veh_3] \n\n ]"
},
"priorities": {
"type": "array",
"items": {
"type": "integer",
"maximum": 255,
"minimum": 0
},
"title": "Priorities",
"example": [
0,
1
],
"nullable": true,
"x-examples": [
[
0,
1
]
],
"description": "dtype: int32 \n\n Priorities of each vehicle, lower the value higher the priority, value should be within [0, 255]"
},
"vehicle_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Vehicle Ids",
"example": [
"veh-1",
"veh-2"
],
"nullable": true,
"x-examples": [
[
"veh-1",
"veh-2"
]
],
"description": "List of the vehicle ids or names provided as a string."
},
"min_vehicles": {
"type": "integer",
"title": "Min Vehicles",
"example": 2,
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"x-examples": [
2
],
"description": "dtype: int32, min_vehicles >= 1. \n\n Solution should consider minimum number of vehicles"
},
"vehicle_types": {
"type": "array",
"items": {
"type": "integer",
"maximum": 255,
"minimum": 0
},
"title": "Vehicle Types",
"example": [
1,
2
],
"nullable": true,
"x-examples": [
[
1,
2
]
],
"description": "dtype: uint8. \n\n Types of vehicles in the fleet given as positive integers."
},
"skip_first_trips": {
"type": "array",
"items": {
"type": "boolean"
},
"title": "Skip First Trips",
"example": [
true,
false
],
"nullable": true,
"x-examples": [
[
true,
false
]
],
"description": "Drop the cost of trip to first location for that vehicle."
},
"drop_return_trips": {
"type": "array",
"items": {
"type": "boolean"
},
"title": "Drop Return Trips",
"example": [
true,
false
],
"nullable": true,
"x-examples": [
[
true,
false
]
],
"description": "Drop cost of return trip for each vehicle."
},
"vehicle_locations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Vehicle Locations",
"example": [
[
0,
0
],
[
0,
0
]
],
"x-examples": [
[
[
0,
0
],
[
0,
0
]
]
],
"description": "dtype: int32, vehicle_location >= 0. \n\n Start and end location of the vehicles in the given set of locations in WayPointGraph or CostMatrices.\nExample: For 2 vehicles, \n\n [ \n\n [veh_1_start_loc, veh_1_end_loc], \n\n [veh_2_start_loc, veh_2_end_loc] \n\n ]"
},
"vehicle_max_costs": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Vehicle Max Costs",
"example": [
7,
10
],
"nullable": true,
"x-examples": [
[
7,
10
]
],
"description": "dtype: float32, max_costs >= 0. \n\n Maximum cost a vehicle can incur and it is based on cost matrix/cost waypoint graph."
},
"vehicle_max_times": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Vehicle Max Times",
"example": [
7,
10
],
"nullable": true,
"x-examples": [
[
7,
10
]
],
"description": "dtype: float32, max_time >= 0. \n\n Maximum time a vehicle can operate (includes drive, service and wait time), this is based on travel time matrix/travel time waypoint graph."
},
"vehicle_fixed_costs": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Vehicle Fixed Costs",
"example": [
15,
5
],
"nullable": true,
"x-examples": [
[
15,
5
]
],
"description": "dtype: float32, fixed_cost >= 0. \n\n Cost of each vehicle.This helps in routing where may be 2 vehicles with less cost is effective compared to 1 vehicle with huge cost. As example shows veh-0 (15) > veh-1 (5) + veh-2 (5)"
},
"vehicle_order_match": {
"type": "array",
"items": {
"type": "object",
"title": "VehicleOrderMatch",
"required": [
"vehicle_id",
"order_ids"
],
"properties": {
"order_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Order Ids",
"description": "dtype: int32, order_id >= 0. \n\n Indices of orders which can be served by this particular vehicle"
},
"vehicle_id": {
"type": "integer",
"title": "Vehicle Id",
"maximum": 2147483647,
"minimum": 0,
"description": "dtype: int32, vehicle_id >= 0. \n\n Vehicle id as an integer, and can serve all the order listed in order_ids."
}
}
},
"title": "Vehicle Order Match",
"example": [
{
"order_ids": [
0
],
"vehicle_id": 0
},
{
"order_ids": [
1
],
"vehicle_id": 1
}
],
"nullable": true,
"x-examples": [
[
{
"order_ids": [
0
],
"vehicle_id": 0
},
{
"order_ids": [
1
],
"vehicle_id": 1
}
]
],
"description": "A list of vehicle order match, where the match would contain a vehicle id and a list of orders that vehicle can serve."
},
"vehicle_time_windows": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Vehicle Time Windows",
"example": [
[
0,
10
],
[
0,
10
]
],
"nullable": true,
"x-examples": [
[
[
0,
10
],
[
0,
10
]
]
],
"description": "dtype: int32, time >= 0. \n\n Earliest and Latest time window pairs for each vehicle,\nfor example the data would look as follows for 2 vehicles, \n \n\n [ \n\n [veh_1_earliest, veh_1_latest], \n\n [veh_2_earliest, veh_2_latest] \n\n ]"
},
"vehicle_break_durations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Vehicle Break Durations",
"example": [
[
1,
1
]
],
"nullable": true,
"x-examples": [
[
[
1,
1
]
]
],
"description": "dtype: int32, time >= 0. \n\n Break duration for each vehicle. vehicle_break_time_windows should be provided to use this option.For example, in case of having 2 breaks for each vehicle, \n\n [ \n\n [brk_1_veh_1_duration, brk_1_veh_2_duration], \n\n [brk_2_veh_1_duration, brk_2_veh_2_duration], \n\n ]"
},
"vehicle_break_locations": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Vehicle Break Locations",
"example": [
0,
1
],
"nullable": true,
"x-examples": [
[
0,
1
]
],
"description": "dtype: int32, location >= 0. \n\n Break location where vehicles can take breaks. If not set, any location can be used for the break."
},
"vehicle_break_time_windows": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
}
},
"title": "Vehicle Break Time Windows",
"example": [
[
[
1,
2
],
[
2,
3
]
]
],
"nullable": true,
"x-examples": [
[
[
[
1,
2
],
[
2,
3
]
]
]
],
"description": "dtype: int32, time >= 0. \n\n Multiple break time windows can be added for each vehicle.Earliest and Latest break time window pairs for each vehicle,\nFor example, in case of 2 sets of breaks for each vehicle which translates to 2 dimensions of breaks,\n \n\n [ \n\n [[brk_1_veh_1_earliest, brk_1_veh_1_latest], [brk_1_veh_2_earliest, brk_1_veh_2_latest]] \n\n [[brk_2_veh_1_earliest, brk_2_veh_1_latest], [brk_2_veh_2_earliest, brk_2_veh_2_latest]] \n\n ] \n\n The break duration within this time window is provided through vehicle_break_durations."
}
}
}
Fq2bamRequestBody
{
"type": "object",
"title": "Fq2bamRequestBody",
"example": [
{
"in_fq": "",
"out_bai": "",
"out_bam": "",
"out_chrs": "",
"out_stderr": "",
"out_stdout": "",
"in_ref_tarball": "",
"additional_args": " --low-memory ",
"out_bam_manifest": ""
}
],
"required": [
"in_ref_tarball",
"in_fq",
"out_bam",
"out_bam_parts_manifest",
"out_bai",
"out_chrs",
"out_stderr",
"out_stdout"
],
"properties": {
"in_fq": {
"type": "string",
"title": "Input FASTQ Files (and Read Groups)",
"minLength": 2
},
"out_bai": {
"type": "string",
"title": "Output BAI File URL",
"minLength": 1
},
"out_bam": {
"type": "array",
"items": {
"type": "string"
},
"title": "Out BAM Presigned URL",
"maxItems": 105,
"minItems": 1
},
"out_chrs": {
"type": "string",
"title": "Output Chromosomes File URL",
"minLength": 0
},
"out_stderr": {
"type": "string",
"title": "Output STDERR URL",
"minLength": 1
},
"out_stdout": {
"type": "string",
"title": "Output STDOUT URL",
"minLength": 1
},
"in_ref_tarball": {
"type": "string",
"title": "Input Reference Tarball",
"pattern": ".*",
"minLength": 1
},
"additional_args": {
"type": "string",
"title": "Additonal Arguments to fq2bam",
"default": "",
"minLength": 0
},
"out_bam_parts_manifest": {
"type": "string",
"title": "Output BAM Parts Manifest",
"minLength": 0
}
}
}
Global
{
"type": "object",
"title": "Global",
"properties": {
"name": {
"const": "Global",
"title": "Name",
"default": "Global"
},
"type": {
"const": "Region",
"title": "Type",
"default": "Region"
},
"lat_max": {
"type": "number",
"title": "Lat Max",
"default": 90
},
"lat_min": {
"type": "number",
"title": "Lat Min",
"default": -90
},
"lon_max": {
"type": "number",
"title": "Lon Max",
"default": 360
},
"lon_min": {
"type": "number",
"title": "Lon Min",
"default": 0
}
},
"description": "Abstract class for defining various regions/windows over the globe."
}
HTTPValidationError
{
"type": "object",
"title": "HTTPValidationError",
"properties": {
"detail": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"maxItems": 10,
"description": "Detailed information about the error."
}
}
}
IOEnum
{
"enum": [
"zarr",
"netcdf",
"h5"
],
"type": "string",
"title": "IOEnum",
"description": "Allow choice of output type."
}
ImageRequest
{
"type": "object",
"title": "ImageRequest",
"required": [
"text_prompts"
],
"properties": {
"seed": {
"type": "integer",
"title": "Seed",
"default": 0,
"minimum": 0,
"description": "The seed which governs generation. Omit this option or use 0 for a random seed",
"exclusiveMaximum": 4294967296
},
"steps": {
"type": "integer",
"title": "Steps",
"default": 25,
"maximum": 100,
"minimum": 5,
"description": "Number of diffusion steps to run"
},
"width": {
"type": "integer",
"title": "Width",
"default": 1024,
"maximum": 1024,
"minimum": 1024,
"description": "Width of the image to generate, in pixels. Only width=1024 is supported"
},
"height": {
"type": "integer",
"title": "Height",
"default": 1024,
"maximum": 1024,
"minimum": 1024,
"description": "Height of the image to generate, in pixels. Only height=1024 is supported"
},
"sampler": {
"enum": [
"DDIM",
"K_EULER_ANCESTRAL",
"K_LMS",
"K_DPM_2_ANCESTRAL"
],
"type": "string",
"title": "Sampler",
"default": "K_DPM_2_ANCESTRAL",
"description": "The sampler to use for generation. Varying diffusion samplers will vary outputs significantly."
},
"samples": {
"type": "integer",
"title": "Samples",
"default": 1,
"maximum": 1,
"minimum": 1,
"description": "Number of images to generate. Only samples=1 is supported"
},
"cfg_scale": {
"type": "number",
"title": "Cfg Scale",
"default": 5,
"maximum": 9,
"minimum": 0,
"description": "How strictly the diffusion process adheres to the prompt text (higher values keep your image closer to your prompt).",
"exclusiveMinimum": 1
},
"style_preset": {
"enum": [
"none"
],
"type": "string",
"title": "Style Preset",
"default": "none",
"description": "Pass in a style preset to guide the image model towards a particular style. This list of style presets is subject to change. style_preset=`none` is supported"
},
"text_prompts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TextPrompt"
},
"title": "Text Prompts",
"maxItems": 2,
"minItems": 1,
"description": "An array of text prompts to use for generation"
},
"clip_guidance_preset": {
"enum": [
"NONE"
],
"type": "string",
"title": "Clip Guidance Preset",
"default": "NONE",
"description": "clip guidance preset. Only clip_guidance_preset=`NONE` is supported"
}
}
}
ImageResponse
{
"type": "object",
"title": "ImageResponse",
"required": [
"artifacts"
],
"properties": {
"artifacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Artifact"
},
"title": "Artifacts",
"maxItems": 1,
"minItems": 1
}
}
}
InFeasibleSolve
{
"type": "object",
"title": "InFeasibleSolve",
"properties": {
"perf_times": {
"type": "object",
"title": "Perf Times",
"nullable": true,
"description": "Etl and Solve times of the solve call"
},
"solver_infeasible_response": {
"allOf": [
{
"type": "object",
"title": "InfeasibleResultData",
"properties": {
"msg": {
"type": "string",
"title": "Msg",
"default": "",
"nullable": true,
"description": "Any information pertaining to the run."
},
"status": {
"type": "integer",
"title": "Status",
"default": 1,
"example": 1,
"maximum": 1,
"minimum": 1,
"x-examples": [
1
],
"description": "1 - Infeasible solution is available \n"
},
"num_vehicles": {
"type": "integer",
"title": "Num Vehicles",
"default": -1,
"example": 2,
"maximum": 2147483647,
"minimum": 0,
"x-examples": [
2
],
"description": "Number of vehicle being used for the solution"
},
"vehicle_data": {
"type": "object",
"title": "Vehicle Data",
"default": {},
"example": {
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
},
"x-examples": [
{
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
}
],
"description": "All the details of vehicle routes and timestamps",
"additionalProperties": {
"type": "object",
"title": "VehicleData",
"properties": {
"type": {
"type": "array",
"items": {
"enum": [
"Depot",
"Pickup",
"Delivery",
"Break",
"w"
],
"type": "string",
"title": "LocationTypeEnum"
},
"title": "Type",
"default": [],
"description": "Type of routing point, whether it is Depot, Waypoint - w \nDelivery, Break, Pickup \n"
},
"route": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Route",
"default": [],
"description": "Route indices as per waypoint graph or cost matrix provided"
},
"task_id": {
"type": "array",
"items": {
"type": "string"
},
"title": "Task Id",
"default": [],
"description": "task_ids being assigned to vehicle along with depot and breaks"
},
"arrival_stamp": {
"type": "array",
"items": {
"type": "number"
},
"title": "Arrival Stamp",
"default": [],
"description": "arrival stamps at each task locations"
}
}
}
},
"solution_cost": {
"type": "number",
"title": "Solution Cost",
"default": -1,
"example": 2,
"x-examples": [
2
],
"description": "Total cost of the solution"
}
}
}
],
"default": {
"msg": "",
"status": 1,
"num_vehicles": -1,
"vehicle_data": {},
"solution_cost": -1
},
"description": "Infeasible solution, this can mean the problem itself is infeasible or solver requires more time to find a solution. Setting default solve time is suggested in case you are not aware of the expected time."
}
}
}
InfeasibleResultData
{
"type": "object",
"title": "InfeasibleResultData",
"properties": {
"msg": {
"type": "string",
"title": "Msg",
"default": "",
"nullable": true,
"description": "Any information pertaining to the run."
},
"status": {
"type": "integer",
"title": "Status",
"default": 1,
"example": 1,
"maximum": 1,
"minimum": 1,
"x-examples": [
1
],
"description": "1 - Infeasible solution is available \n"
},
"num_vehicles": {
"type": "integer",
"title": "Num Vehicles",
"default": -1,
"example": 2,
"maximum": 2147483647,
"minimum": 0,
"x-examples": [
2
],
"description": "Number of vehicle being used for the solution"
},
"vehicle_data": {
"type": "object",
"title": "Vehicle Data",
"default": {},
"example": {
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
},
"x-examples": [
{
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
}
],
"description": "All the details of vehicle routes and timestamps",
"additionalProperties": {
"type": "object",
"title": "VehicleData",
"properties": {
"type": {
"type": "array",
"items": {
"enum": [
"Depot",
"Pickup",
"Delivery",
"Break",
"w"
],
"type": "string",
"title": "LocationTypeEnum"
},
"title": "Type",
"default": [],
"description": "Type of routing point, whether it is Depot, Waypoint - w \nDelivery, Break, Pickup \n"
},
"route": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Route",
"default": [],
"description": "Route indices as per waypoint graph or cost matrix provided"
},
"task_id": {
"type": "array",
"items": {
"type": "string"
},
"title": "Task Id",
"default": [],
"description": "task_ids being assigned to vehicle along with depot and breaks"
},
"arrival_stamp": {
"type": "array",
"items": {
"type": "number"
},
"title": "Arrival Stamp",
"default": [],
"description": "arrival stamps at each task locations"
}
}
}
},
"solution_cost": {
"type": "number",
"title": "Solution Cost",
"default": -1,
"example": 2,
"x-examples": [
2
],
"description": "Total cost of the solution"
}
}
}
InferenceModels
{
"enum": [
"persistence_1step",
"sfno_73ch"
],
"type": "string",
"title": "InferenceModels",
"description": "Inference Model Options."
}
InferenceRequest
{
"type": "object",
"title": "InferenceRequest",
"example": {
"image": "https://raw.githubusercontent.com/NVIDIA/ai-assisted-annotation-client/master/py_client/test-data/image.nii.gz",
"prompts": {
"classes": [
"spleen",
"liver"
]
}
},
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"title": "Image",
"example": "https://raw.githubusercontent.com/NVIDIA/ai-assisted-annotation-client/master/py_client/test-data/image.nii.gz",
"x-examples": [
"https://raw.githubusercontent.com/NVIDIA/ai-assisted-annotation-client/master/py_client/test-data/image.nii.gz"
],
"description": "A Valid URL representing a 3D medical Image (nifti/nrrd)"
},
"output": {
"$ref": "#/components/schemas/OutputTypeNullable"
},
"prompts": {
"$ref": "#/components/schemas/PromptsNullable"
}
},
"x-examples": [
{
"image": "https://raw.githubusercontent.com/NVIDIA/ai-assisted-annotation-client/master/py_client/test-data/image.nii.gz",
"prompts": {
"classes": [
"spleen",
"liver"
]
}
}
]
}
LigandFormat
{
"enum": [
"mol2",
"sdf"
],
"type": "string",
"title": "LigandFormat"
}
LocationTypeEnum
{
"enum": [
"Depot",
"Pickup",
"Delivery",
"Break",
"w"
],
"type": "string",
"title": "LocationTypeEnum"
}
Message
{
"type": "object",
"title": "Message",
"required": [
"role"
],
"properties": {
"name": {
"type": "string",
"title": "Name",
"default": null,
"nullable": true,
"maxLength": 64,
"description": "The name of the author of this message. Cannot be used with role=`system`. May contain a-z, A-Z, 0-9, and underscores, with a maximum length of 64 characters."
},
"role": {
"enum": [
"system",
"user",
"assistant"
],
"type": "string",
"title": "Role",
"description": "The role of the message author."
},
"content": {
"type": "string",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/UserTextContent"
},
{
"$ref": "#/components/schemas/UserImageContent"
}
]
}
}
],
"title": "Content",
"default": null,
"nullable": true,
"description": "The contents of the message.\n<br>Can only be `null` as part of a last request message with role=`assistant` (for \"completion mode\", i.e. providing the beginning of the assistant response).\n<br>To pass images (only with role=`user`):\n<br> - When content is a string, images can be passed together with the text with `img` HTML tags with base64 data: `<img src=\"data:image/{format};base64,{base64encodedimage}\" />` .\n If the size of an image is more than 200KB, it needs to be uploaded to a presigned S3 bucket using NVCF Asset APIs. Once uploaded you can refer to it using the following format: `<img src=\"data:image/png;asset_id,{asset_id}\" />` .\n<br> - When content is a list of objects, images can be passed with objects with type=`image_url`, and image_url containing the base64 image data: `data:image/{format};base64,{base64encodedimage}`. HTML `img` tags will not be parsed from objects with type=`text`.\n<br> - In both cases, images can be PNG, JPG or JPEG.\n<br>For `system` and `assistant` roles, the object list format is not supported.\n"
}
}
}
MessageWithEntities
{
"type": "object",
"title": "MessageWithEntities",
"required": [
"role",
"entities"
],
"properties": {
"role": {
"enum": [
"user",
"assistant"
],
"type": "string",
"title": "Role",
"description": "The role of the message author."
},
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/UserTextContent"
},
{
"$ref": "#/components/schemas/UserImageContent"
}
]
}
}
],
"title": "Content",
"default": null,
"nullable": true,
"description": "The contents of the request.\n<br>Can only be `null` as part of a last request message with role=`assistant` (used to give a role or labels for the next generation).\n<br>To pass images (only with role=`user`):\n<br> - When content is a string, images can be passed together with the text with `img` HTML tags with base64 data: `<img src=\"data:image/{format};base64,{base64encodedimage}\" />` .\n If the size of an image is more than 200KB, it needs to be uploaded to a presigned S3 bucket using NVCF Asset APIs. Once uploaded you can refer to it using the following format: `<img src=\"data:image/png;asset_id,{asset_id}\" />` .\n<br> - When content is a list of objects, images can be passed with objects with type=`image_url`, and image_url containing the base64 image data: `data:image/{format};base64,{base64encodedimage}`. HTML `img` tags will not be parsed from objects with type=`text`.\n<br> - In both cases, images can be PNG, JPG or JPEG.\n<br>For `assistant` role, the object list format is not supported.\n"
},
"entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Entity"
},
"title": "Entities",
"example": [
{
"bboxes": [
[
0.171875,
0.421875,
0.453125,
0.984375
],
[
0.609375,
0.421875,
0.796875,
0.984375
],
[
0.421875,
0.453125,
0.609375,
0.984375
],
[
0.203125,
0.171875,
0.390625,
0.578125
]
],
"phrase": "young soccer players",
"substring": [
45,
64
]
}
],
"x-examples": [
[
{
"bboxes": [
[
0.171875,
0.421875,
0.453125,
0.984375
],
[
0.609375,
0.421875,
0.796875,
0.984375
],
[
0.421875,
0.453125,
0.609375,
0.984375
],
[
0.203125,
0.171875,
0.390625,
0.578125
]
],
"phrase": "young soccer players",
"substring": [
45,
64
]
}
]
],
"description": "List of entities along with bounding boxes referring the generated text and input image"
}
}
}
ModelIdentifier
{
"type": "string",
"const": "nv-rerank-qa-mistral-4b:1",
"title": "ModelIdentifier",
"example": "nv-rerank-qa-mistral-4b:1",
"description": "Supported models."
}
ModelInfo
{
"type": "object",
"title": "ModelInfo",
"required": [
"name",
"description",
"version",
"labels"
],
"properties": {
"name": {
"type": "string",
"title": "Model",
"example": "VISTA-3D",
"x-examples": [
"VISTA-3D"
],
"description": "Name of Model"
},
"labels": {
"type": "object",
"title": "Labels",
"example": {
"1": "liver",
"2": "kidney",
"3": "spleen",
"4": "pancreas",
"5": "right kidney",
"6": "aorta",
"7": "inferior vena cava",
"8": "right adrenal gland",
"9": "left adrenal gland",
"10": "gallbladder",
"11": "esophagus",
"12": "stomach",
"13": "duodenum",
"14": "left kidney",
"15": "postcava",
"16": "bladder",
"17": "prostate or uterus",
"18": "portal vein and splenic vein",
"19": "uterus",
"20": "rectum",
"21": "small bowel",
"22": "lung",
"23": "bone",
"24": "brain",
"25": "lung tumor",
"26": "pancreatic tumor",
"27": "hepatic vessel",
"28": "hepatic tumor",
"29": "colon cancer primaries",
"30": "left lung upper lobe",
"31": "left lung lower lobe",
"32": "right lung upper lobe",
"33": "right lung middle lobe",
"34": "right lung lower lobe",
"35": "vertebrae l5",
"36": "vertebrae l4",
"37": "vertebrae l3",
"38": "vertebrae l2",
"39": "vertebrae l1",
"40": "vertebrae t12",
"41": "vertebrae t11",
"42": "vertebrae t10",
"43": "vertebrae t9",
"44": "vertebrae t8",
"45": "vertebrae t7",
"46": "vertebrae t6",
"47": "vertebrae t5",
"48": "vertebrae t4",
"49": "vertebrae t3",
"50": "vertebrae t2",
"51": "vertebrae t1",
"52": "vertebrae c7",
"53": "vertebrae c6",
"54": "vertebrae c5",
"55": "vertebrae c4",
"56": "vertebrae c3",
"57": "vertebrae c2",
"58": "vertebrae c1",
"59": "trachea",
"60": "heart myocardium",
"61": "left heart atrium",
"62": "left heart ventricle",
"63": "right heart atrium",
"64": "right heart ventricle",
"65": "pulmonary artery",
"66": "left iliac artery",
"67": "right iliac artery",
"68": "left iliac vena",
"69": "right iliac vena",
"70": "colon",
"71": "left rib 1",
"72": "left rib 2",
"73": "left rib 3",
"74": "left rib 4",
"75": "left rib 5",
"76": "left rib 6",
"77": "left rib 7",
"78": "left rib 8",
"79": "left rib 9",
"80": "left rib 10",
"81": "left rib 11",
"82": "left rib 12",
"83": "right rib 1",
"84": "right rib 2",
"85": "right rib 3",
"86": "right rib 4",
"87": "right rib 5",
"88": "right rib 6",
"89": "right rib 7",
"90": "right rib 8",
"91": "right rib 9",
"92": "right rib 10",
"93": "right rib 11",
"94": "right rib 12",
"95": "left humerus",
"96": "right humerus",
"97": "left scapula",
"98": "right scapula",
"99": "left clavicula",
"100": "right clavicula",
"101": "left femur",
"102": "right femur",
"103": "left hip",
"104": "right hip",
"105": "sacrum",
"106": "face",
"107": "left gluteus maximus",
"108": "right gluteus maximus",
"109": "left gluteus medius",
"110": "right gluteus medius",
"111": "left gluteus minimus",
"112": "right gluteus minimus",
"113": "left autochthon",
"114": "right autochthon",
"115": "left iliopsoas",
"116": "right iliopsoas",
"117": "bone lesion"
},
"x-examples": [
{
"1": "liver",
"2": "kidney",
"3": "spleen",
"4": "pancreas",
"5": "right kidney",
"6": "aorta",
"7": "inferior vena cava",
"8": "right adrenal gland",
"9": "left adrenal gland",
"10": "gallbladder",
"11": "esophagus",
"12": "stomach",
"13": "duodenum",
"14": "left kidney",
"15": "postcava",
"16": "bladder",
"17": "prostate or uterus",
"18": "portal vein and splenic vein",
"19": "uterus",
"20": "rectum",
"21": "small bowel",
"22": "lung",
"23": "bone",
"24": "brain",
"25": "lung tumor",
"26": "pancreatic tumor",
"27": "hepatic vessel",
"28": "hepatic tumor",
"29": "colon cancer primaries",
"30": "left lung upper lobe",
"31": "left lung lower lobe",
"32": "right lung upper lobe",
"33": "right lung middle lobe",
"34": "right lung lower lobe",
"35": "vertebrae l5",
"36": "vertebrae l4",
"37": "vertebrae l3",
"38": "vertebrae l2",
"39": "vertebrae l1",
"40": "vertebrae t12",
"41": "vertebrae t11",
"42": "vertebrae t10",
"43": "vertebrae t9",
"44": "vertebrae t8",
"45": "vertebrae t7",
"46": "vertebrae t6",
"47": "vertebrae t5",
"48": "vertebrae t4",
"49": "vertebrae t3",
"50": "vertebrae t2",
"51": "vertebrae t1",
"52": "vertebrae c7",
"53": "vertebrae c6",
"54": "vertebrae c5",
"55": "vertebrae c4",
"56": "vertebrae c3",
"57": "vertebrae c2",
"58": "vertebrae c1",
"59": "trachea",
"60": "heart myocardium",
"61": "left heart atrium",
"62": "left heart ventricle",
"63": "right heart atrium",
"64": "right heart ventricle",
"65": "pulmonary artery",
"66": "left iliac artery",
"67": "right iliac artery",
"68": "left iliac vena",
"69": "right iliac vena",
"70": "colon",
"71": "left rib 1",
"72": "left rib 2",
"73": "left rib 3",
"74": "left rib 4",
"75": "left rib 5",
"76": "left rib 6",
"77": "left rib 7",
"78": "left rib 8",
"79": "left rib 9",
"80": "left rib 10",
"81": "left rib 11",
"82": "left rib 12",
"83": "right rib 1",
"84": "right rib 2",
"85": "right rib 3",
"86": "right rib 4",
"87": "right rib 5",
"88": "right rib 6",
"89": "right rib 7",
"90": "right rib 8",
"91": "right rib 9",
"92": "right rib 10",
"93": "right rib 11",
"94": "right rib 12",
"95": "left humerus",
"96": "right humerus",
"97": "left scapula",
"98": "right scapula",
"99": "left clavicula",
"100": "right clavicula",
"101": "left femur",
"102": "right femur",
"103": "left hip",
"104": "right hip",
"105": "sacrum",
"106": "face",
"107": "left gluteus maximus",
"108": "right gluteus maximus",
"109": "left gluteus medius",
"110": "right gluteus medius",
"111": "left gluteus minimus",
"112": "right gluteus minimus",
"113": "left autochthon",
"114": "right autochthon",
"115": "left iliopsoas",
"116": "right iliopsoas",
"117": "bone lesion"
}
],
"description": "Label Names/Indices supported by the Model",
"additionalProperties": {
"type": "string"
}
},
"version": {
"type": "string",
"title": "Version",
"example": "0.2.1",
"x-examples": [
"0.2.1"
],
"description": "Version of Pre-trained Model"
},
"description": {
"type": "string",
"title": "Description",
"example": "VISTA-3D model based on MONAI",
"x-examples": [
"VISTA-3D model based on MONAI"
],
"description": "Description of Model"
}
}
}
ModelsRunInferenceVista3DResponse
{
"type": "string",
"format": "binary"
}
MolecularDecodeRequest
{
"type": "object",
"title": "MolecularDecodeRequest",
"required": [
"shape",
"embeddings"
],
"properties": {
"shape": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Shape",
"nullable": true
},
"format": {
"$ref": "#/components/schemas/EmbeddingFormatNullable"
},
"asset_id": {
"type": "string",
"title": "Asset Id",
"nullable": true
},
"embeddings": {
"type": "array",
"items": {
"type": "number"
},
"title": "Embeddings",
"nullable": true
}
}
}
MolecularDockingRequest
{
"type": "object",
"title": "MolecularDockingRequest",
"required": [
"ligand",
"ligand_file_type",
"protein"
],
"properties": {
"steps": {
"type": "integer",
"title": "Number of diffusion steps",
"default": 18,
"maximum": 100,
"minimum": 1,
"description": "Number of diffusion steps to be computed"
},
"ligand": {
"type": "string",
"title": "Ligand(mol2, SDF or NVCF Asset)",
"description": "Ligand to be docked. Mol2 string or NVCF asset id"
},
"protein": {
"type": "string",
"title": "Protein(PDB)",
"description": "Protein(PDB). PDB string or NVCF asset id"
},
"is_staged": {
"type": "boolean",
"title": "Is staged?",
"default": true,
"description": "Are the files for ligand and protein staged?"
},
"num_poses": {
"type": "integer",
"title": "Number of poses",
"default": 20,
"maximum": 100,
"minimum": 1,
"description": "Number of poses to generate"
},
"time_divisions": {
"type": "integer",
"title": "Number of diffusion time divisions",
"default": 20,
"maximum": 100,
"minimum": 1,
"description": "Number of diffusion time divisions"
},
"save_trajectory": {
"type": "boolean",
"title": "Return the trajectory",
"default": false,
"description": "Return the trajectory"
},
"ligand_file_type": {
"$ref": "#/components/schemas/LigandFormat"
}
},
"x-konfig-properties": {
"ligand_file_type": {
"title": "Ligand data Format (mol2 or SDF)",
"description": "Ligand(mol2) to be docked. Mol2 string or NVCF asset id"
}
}
}
MolecularDockingResponse
{
"type": "object",
"example": {},
"properties": {}
}
MolecularEmbeddingRequest
{
"type": "object",
"title": "MolecularEmbeddingRequest",
"required": [
"smis"
],
"properties": {
"smis": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\[[^\\]]+]|Br?|Cl?|N|O|S|P|F|I|b|c|n|o|s|p|\\(|\\)|\\.|=|#|-|\\+|\\\\|\\/|:|~|@|\\?|>|\\*|\\$|\\%[0-9]{2}|[0-9]",
"maxLength": 510,
"minLength": 1
},
"title": "SMILES",
"maxItems": 32,
"minItems": 1,
"description": "SMILES"
},
"format": {
"$ref": "#/components/schemas/EmbeddingFormat"
}
},
"x-konfig-properties": {
"format": {
"title": "Expected output format(npz|h5)",
"default": "npz",
"description": "Expected embedding output format"
}
}
}
MoleculeGenerateResponse
{
"type": "object",
"example": {},
"properties": {}
}
MoleculeGenerationBody
{
"type": "object",
"title": "MoleculeGenerationBody",
"properties": {
"smi": {
"type": "string",
"title": "Smi"
},
"minimize": {
"type": "boolean",
"title": "Minimize",
"default": false
},
"algorithm": {
"$ref": "#/components/schemas/ControlGenerationAlgo"
},
"particles": {
"type": "integer",
"title": "Particles",
"default": 20,
"maximum": 1000,
"minimum": 2
},
"iterations": {
"type": "integer",
"title": "Iterations",
"default": 10,
"maximum": 1000,
"minimum": 1
},
"num_molecules": {
"type": "integer",
"title": "Num Molecules",
"default": 10,
"maximum": 100,
"minimum": 1
},
"property_name": {
"$ref": "#/components/schemas/ControlGenerationProp"
},
"scaled_radius": {
"type": "number",
"title": "Scaled Radius",
"default": 1,
"maximum": 2,
"minimum": 0
},
"min_similarity": {
"type": "number",
"title": "Min Similarity",
"default": 0.7,
"maximum": 1,
"minimum": 0
}
},
"x-konfig-properties": {
"algorithm": {
"default": "CMA-ES"
},
"property_name": {
"default": "QED"
}
}
}
MultiModalData
{
"type": "object",
"title": "MultiModalData",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"title": "Text",
"pattern": ".*",
"maxLength": 9728,
"minLength": 1
}
},
"description": "A type signifier for multimodal data.\n\nSupported data types: text."
}
MultiPoint
{
"type": "object",
"title": "MultiPoint",
"required": [
"type",
"name",
"lat",
"lon",
"location"
],
"properties": {
"lat": {
"type": "array",
"items": {
"type": "number"
},
"title": "Lat",
"maxItems": 100
},
"lon": {
"type": "array",
"items": {
"type": "number"
},
"title": "Lon",
"maxItems": 100
},
"name": {
"type": "string",
"title": "Name",
"pattern": "[A-Za-z\\s\\.]+",
"maxLength": 40
},
"type": {
"const": "MultiPoint",
"title": "Type"
},
"location": {
"type": "array",
"items": {
"type": "string",
"pattern": "[A-Za-z\\s\\.]+",
"maxLength": 40
},
"title": "Location",
"maxItems": 100
}
},
"description": "MultiPoint domain, specifies a list of lat/lon points.\n\nParameters\n----------\nlat : List[float]\n latitude points.\nlon : List[float]\n longitude points.\nlocation : Union[List[str], List[int]]\n Name given to the collection of lat/lon points.\ndiagnostics : List[Diagnostic]\n List of diagnostics to be computed for this domain."
}
MultimodalApiInvokeModelInferenceResponse
{
"type": "object",
"example": {},
"properties": {}
}
MultimodalApiRequestModelInferenceResponse
{
"type": "object",
"example": {},
"properties": {}
}
MultimodalApiRequestModelResponse202Response
{
"type": "object",
"example": {},
"properties": {}
}
MultimodalApiRequestModelResponseResponse
{
"type": "object",
"example": {},
"properties": {}
}
NoPerturb
{
"type": "object",
"title": "NoPerturb",
"properties": {
"type": {
"const": "NoPerturb",
"title": "Type",
"default": "NoPerturb"
}
},
"description": "No perturbation scheme."
}
Objective
{
"type": "object",
"title": "Objective",
"properties": {
"cost": {
"type": "number",
"title": "Cost",
"example": 1,
"nullable": true,
"x-examples": [
1
],
"description": "dtype: float32. \n\n The weight assigned to minimizing the cost for a given solution, default value is 1"
},
"prize": {
"type": "number",
"title": "Prize",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the prize in accumulated prizes for each job fulfilled.This will be negated from overall values accumulated with other objectives.For example, if cost accumulated is 10 and objective value for it is 1, and if the prize accumulated is 3 and objective is 2, then total cost would look something like this 10 x 1 - 3 x 2 = 4."
},
"travel_time": {
"type": "number",
"title": "Travel Time",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to minimizing total travel time for a given solution (includes drive, service and wait time)"
},
"vehicle_fixed_cost": {
"type": "number",
"title": "Vehicle Fixed Cost",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the accumulated fixed costs of each vehicle used in solution"
},
"variance_route_size": {
"type": "number",
"title": "Variance Route Size",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the variance in the number of orders served by each route."
},
"variance_route_service_time": {
"type": "number",
"title": "Variance Route Service Time",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the variance in the accumulated service times of each route"
}
}
}
OptimizedRoutingData
{
"type": "object",
"title": "OptimizedRoutingData",
"required": [
"fleet_data",
"task_data"
],
"properties": {
"task_data": {
"allOf": [
{
"type": "object",
"title": "TaskData",
"required": [
"task_locations"
],
"properties": {
"demand": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Demand",
"example": [
[
1,
1
],
[
3,
1
]
],
"nullable": true,
"x-examples": [
[
[
1,
1
],
[
3,
1
]
]
],
"description": "dtype: int32 \n\n Note: For this release number of demand dimensions are limited to 3. \n\n Lists of demands of each tasks.\nMultiple demands can be added and each list represents one kind of demand. Order of these demands should match the type of vehicle capacities provided.Example: In case of two sets of demands per vehicle with 3 vehicles, \n\n [ \n\n [dem_1_tsk_1, dem_1_tsk_2, dem_1_tsk_3], \n\n [dem_2_tsk_1, dem_2_tsk_2, dem_2_tsk_3] \n\n ]"
},
"prizes": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Prizes",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "dtype: float32, prizes >= 0. \n\n List of values which signifies prizes that are collected for fulfilling each task. This can be used effectively in case solution is infeasible and need to drop few tasks to get feasible solution. Solver will prioritize for higher prize tasks "
},
"task_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Task Ids",
"example": [
"Task-A",
"Task-B"
],
"nullable": true,
"x-examples": [
[
"Task-A",
"Task-B"
]
],
"description": "List of the task ids or names provided as a string."
},
"service_times": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
{
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "integer"
}
}
}
],
"title": "Service Times",
"example": [
0,
0
],
"nullable": true,
"x-examples": [
[
0,
0
]
],
"description": "dtype: int32, time >= 0. \n\n Service time for each task. Accepts a list of service times for all vehicles. In case of vehicle specific service times, accepts a dict with key as vehicle id and value as list of service times.Example schema: In case all vehicles have same service times, \n\n [tsk_1_srv_time, tsk_2_srv_time, tsk_3_srv_time] \n\n \n\n In case, there are 2 types of vehicle types and each of them have different service times, \n\n { \n\n type-1: [tsk_1_srv_time, tsk_3_srv_time, tsk_3_srv_time], \n\n type-2: [tsk_1_srv_time, tsk_3_srv_time, tsk_3_srv_time] \n\n }"
},
"task_locations": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Task Locations",
"example": [
1,
2
],
"x-examples": [
[
1,
2
]
],
"description": "dtype: int32, location >= 0. \n\n Location where the task has been requested."
},
"task_time_windows": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Task Time Windows",
"example": [
[
0,
5
],
[
3,
9
]
],
"nullable": true,
"x-examples": [
[
[
0,
5
],
[
3,
9
]
]
],
"description": "dtype: int32, time >= 0. \n\n Earliest and Latest time windows for each tasks.\nFor example the data would look as follows, \n \n\n [ \n\n [tsk_1_earliest, tsk_1_latest], \n\n [tsk_2_earliest, tsk_2_latest] \n\n ]"
},
"mandatory_task_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Mandatory Task Ids",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "dtype: int32, mandatory_task_id >= 0. \n\n Note: This is only effective when used along with drop infeasible option. \n\n A list of task ids which are mandatory and solver would fail if these cannot be fulfilled."
},
"order_vehicle_match": {
"type": "array",
"items": {
"type": "object",
"title": "OrderVehicleMatch",
"required": [
"order_id",
"vehicle_ids"
],
"properties": {
"order_id": {
"type": "integer",
"title": "Order Id",
"maximum": 2147483647,
"minimum": 0,
"description": "dtype: int32, order_id >= 0. \n\n Indices of orders which can be served by this particular vehicleOrder id as an integer"
},
"vehicle_ids": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Vehicle Ids",
"maximum": 2147483647,
"minimum": 0,
"description": "dtype: int32, vehicle_id >= 0. \n\n Indices of the vehicles which can serve this particular order. \n"
}
}
},
"title": "Order Vehicle Match",
"example": [
{
"order_id": 0,
"vehicle_ids": [
0
]
},
{
"order_id": 1,
"vehicle_ids": [
1
]
}
],
"nullable": true,
"x-examples": [
[
{
"order_id": 0,
"vehicle_ids": [
0
]
},
{
"order_id": 1,
"vehicle_ids": [
1
]
}
]
],
"description": "A list of order vehicle match, where the match would contain a order id and a list of vehicle ids that can serve this order."
},
"pickup_and_delivery_pairs": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Pickup And Delivery Pairs",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "dtype: int32, pairs >= 0. \n\n List of Pick-up and delivery index pairs from task locations.\nIn case we have the following pick-up and delivery locations, 2->1, 4->5, 3->4, then task locations would look something like, task_locations = [0, 2, 1, 4, 5, 3, 4] and pick-up and delivery pairs would be index of those locations in task location and would look like [[1, 2], [3, 4], [5, 6]], 1 is pickup index for location 2 and it should be delivered to location 1 which is at index 2.Example schema: \n\n [ \n\n [pcikup_1_idx_to_task, drop_1_idx_to_task], \n\n [pcikup_2_idx_to_task, drop_2_idx_to_task], \n\n ]"
}
}
}
],
"description": "All Task information"
},
"fleet_data": {
"allOf": [
{
"type": "object",
"title": "FleetData",
"required": [
"vehicle_locations"
],
"properties": {
"capacities": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Capacities",
"example": [
[
2,
2
],
[
4,
1
]
],
"nullable": true,
"x-examples": [
[
[
2,
2
],
[
4,
1
]
]
],
"description": "dtype: int32, capacity >= 0. \n\n Note: For this release number of capacity dimensions are limited to 3. \n\n Lists of capacities of each vehicle.\nMultiple capacities can be added and each list will represent one kind of capacity. Order of kind of the capacities should match order of the demands.\nTotal capacity for each type should be sufficient to complete all demand of that type.Example: In case of two sets of capacities per vehicle with 3 vehicles, \n\n [ \n\n [cap_1_veh_1, cap_1_veh_2, cap_1_veh_3], \n\n [cap_2_veh_1, cap_2_veh_2, cap_2_veh_3] \n\n ]"
},
"priorities": {
"type": "array",
"items": {
"type": "integer",
"maximum": 255,
"minimum": 0
},
"title": "Priorities",
"example": [
0,
1
],
"nullable": true,
"x-examples": [
[
0,
1
]
],
"description": "dtype: int32 \n\n Priorities of each vehicle, lower the value higher the priority, value should be within [0, 255]"
},
"vehicle_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Vehicle Ids",
"example": [
"veh-1",
"veh-2"
],
"nullable": true,
"x-examples": [
[
"veh-1",
"veh-2"
]
],
"description": "List of the vehicle ids or names provided as a string."
},
"min_vehicles": {
"type": "integer",
"title": "Min Vehicles",
"example": 2,
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"x-examples": [
2
],
"description": "dtype: int32, min_vehicles >= 1. \n\n Solution should consider minimum number of vehicles"
},
"vehicle_types": {
"type": "array",
"items": {
"type": "integer",
"maximum": 255,
"minimum": 0
},
"title": "Vehicle Types",
"example": [
1,
2
],
"nullable": true,
"x-examples": [
[
1,
2
]
],
"description": "dtype: uint8. \n\n Types of vehicles in the fleet given as positive integers."
},
"skip_first_trips": {
"type": "array",
"items": {
"type": "boolean"
},
"title": "Skip First Trips",
"example": [
true,
false
],
"nullable": true,
"x-examples": [
[
true,
false
]
],
"description": "Drop the cost of trip to first location for that vehicle."
},
"drop_return_trips": {
"type": "array",
"items": {
"type": "boolean"
},
"title": "Drop Return Trips",
"example": [
true,
false
],
"nullable": true,
"x-examples": [
[
true,
false
]
],
"description": "Drop cost of return trip for each vehicle."
},
"vehicle_locations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Vehicle Locations",
"example": [
[
0,
0
],
[
0,
0
]
],
"x-examples": [
[
[
0,
0
],
[
0,
0
]
]
],
"description": "dtype: int32, vehicle_location >= 0. \n\n Start and end location of the vehicles in the given set of locations in WayPointGraph or CostMatrices.\nExample: For 2 vehicles, \n\n [ \n\n [veh_1_start_loc, veh_1_end_loc], \n\n [veh_2_start_loc, veh_2_end_loc] \n\n ]"
},
"vehicle_max_costs": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Vehicle Max Costs",
"example": [
7,
10
],
"nullable": true,
"x-examples": [
[
7,
10
]
],
"description": "dtype: float32, max_costs >= 0. \n\n Maximum cost a vehicle can incur and it is based on cost matrix/cost waypoint graph."
},
"vehicle_max_times": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Vehicle Max Times",
"example": [
7,
10
],
"nullable": true,
"x-examples": [
[
7,
10
]
],
"description": "dtype: float32, max_time >= 0. \n\n Maximum time a vehicle can operate (includes drive, service and wait time), this is based on travel time matrix/travel time waypoint graph."
},
"vehicle_fixed_costs": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Vehicle Fixed Costs",
"example": [
15,
5
],
"nullable": true,
"x-examples": [
[
15,
5
]
],
"description": "dtype: float32, fixed_cost >= 0. \n\n Cost of each vehicle.This helps in routing where may be 2 vehicles with less cost is effective compared to 1 vehicle with huge cost. As example shows veh-0 (15) > veh-1 (5) + veh-2 (5)"
},
"vehicle_order_match": {
"type": "array",
"items": {
"type": "object",
"title": "VehicleOrderMatch",
"required": [
"vehicle_id",
"order_ids"
],
"properties": {
"order_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Order Ids",
"description": "dtype: int32, order_id >= 0. \n\n Indices of orders which can be served by this particular vehicle"
},
"vehicle_id": {
"type": "integer",
"title": "Vehicle Id",
"maximum": 2147483647,
"minimum": 0,
"description": "dtype: int32, vehicle_id >= 0. \n\n Vehicle id as an integer, and can serve all the order listed in order_ids."
}
}
},
"title": "Vehicle Order Match",
"example": [
{
"order_ids": [
0
],
"vehicle_id": 0
},
{
"order_ids": [
1
],
"vehicle_id": 1
}
],
"nullable": true,
"x-examples": [
[
{
"order_ids": [
0
],
"vehicle_id": 0
},
{
"order_ids": [
1
],
"vehicle_id": 1
}
]
],
"description": "A list of vehicle order match, where the match would contain a vehicle id and a list of orders that vehicle can serve."
},
"vehicle_time_windows": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Vehicle Time Windows",
"example": [
[
0,
10
],
[
0,
10
]
],
"nullable": true,
"x-examples": [
[
[
0,
10
],
[
0,
10
]
]
],
"description": "dtype: int32, time >= 0. \n\n Earliest and Latest time window pairs for each vehicle,\nfor example the data would look as follows for 2 vehicles, \n \n\n [ \n\n [veh_1_earliest, veh_1_latest], \n\n [veh_2_earliest, veh_2_latest] \n\n ]"
},
"vehicle_break_durations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Vehicle Break Durations",
"example": [
[
1,
1
]
],
"nullable": true,
"x-examples": [
[
[
1,
1
]
]
],
"description": "dtype: int32, time >= 0. \n\n Break duration for each vehicle. vehicle_break_time_windows should be provided to use this option.For example, in case of having 2 breaks for each vehicle, \n\n [ \n\n [brk_1_veh_1_duration, brk_1_veh_2_duration], \n\n [brk_2_veh_1_duration, brk_2_veh_2_duration], \n\n ]"
},
"vehicle_break_locations": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Vehicle Break Locations",
"example": [
0,
1
],
"nullable": true,
"x-examples": [
[
0,
1
]
],
"description": "dtype: int32, location >= 0. \n\n Break location where vehicles can take breaks. If not set, any location can be used for the break."
},
"vehicle_break_time_windows": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
}
},
"title": "Vehicle Break Time Windows",
"example": [
[
[
1,
2
],
[
2,
3
]
]
],
"nullable": true,
"x-examples": [
[
[
[
1,
2
],
[
2,
3
]
]
]
],
"description": "dtype: int32, time >= 0. \n\n Multiple break time windows can be added for each vehicle.Earliest and Latest break time window pairs for each vehicle,\nFor example, in case of 2 sets of breaks for each vehicle which translates to 2 dimensions of breaks,\n \n\n [ \n\n [[brk_1_veh_1_earliest, brk_1_veh_1_latest], [brk_1_veh_2_earliest, brk_1_veh_2_latest]] \n\n [[brk_2_veh_1_earliest, brk_2_veh_1_latest], [brk_2_veh_2_earliest, brk_2_veh_2_latest]] \n\n ] \n\n The break duration within this time window is provided through vehicle_break_durations."
}
}
}
],
"description": "All Fleet information"
},
"solver_config": {
"type": "object",
"title": "UpdateSolverSettingsConfig",
"nullable": true,
"properties": {
"objectives": {
"type": "object",
"title": "Objective",
"nullable": true,
"properties": {
"cost": {
"type": "number",
"title": "Cost",
"example": 1,
"nullable": true,
"x-examples": [
1
],
"description": "dtype: float32. \n\n The weight assigned to minimizing the cost for a given solution, default value is 1"
},
"prize": {
"type": "number",
"title": "Prize",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the prize in accumulated prizes for each job fulfilled.This will be negated from overall values accumulated with other objectives.For example, if cost accumulated is 10 and objective value for it is 1, and if the prize accumulated is 3 and objective is 2, then total cost would look something like this 10 x 1 - 3 x 2 = 4."
},
"travel_time": {
"type": "number",
"title": "Travel Time",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to minimizing total travel time for a given solution (includes drive, service and wait time)"
},
"vehicle_fixed_cost": {
"type": "number",
"title": "Vehicle Fixed Cost",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the accumulated fixed costs of each vehicle used in solution"
},
"variance_route_size": {
"type": "number",
"title": "Variance Route Size",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the variance in the number of orders served by each route."
},
"variance_route_service_time": {
"type": "number",
"title": "Variance Route Service Time",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the variance in the accumulated service times of each route"
}
},
"description": "Values provided dictate the linear combination of factors used to evaluate solution quality.Only prize will be negated, all others gets accumulated. That's why sometime you might come across negative value as solution cost."
},
"time_limit": {
"type": "number",
"title": "Time Limit",
"example": 1,
"minimum": 0,
"nullable": true,
"x-examples": [
1
],
"description": "SolverSettings time limit"
},
"config_file": {
"type": "string",
"title": "Config File",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "Dump configuration information in a given file as yaml"
},
"verbose_mode": {
"type": "boolean",
"title": "Verbose Mode",
"default": false,
"nullable": true,
"description": "Displaying internal information during the solver execution."
},
"error_logging": {
"type": "boolean",
"title": "Error Logging",
"default": true,
"nullable": true,
"description": "Displaying constraint error information during the solver execution."
},
"drop_infeasible_tasks": {
"type": "boolean",
"title": "Drop Infeasible Tasks",
"default": false,
"nullable": true,
"description": "Note: Prize collection is recommend for finer control over \n\n what tasks would be picked or dropped. Drops infeasible tasks and returns routes for only feasible tasks. This should be used when solver fails to find a solution to fulfill all the tasks/order, "
}
}
},
"cost_matrix_data": {
"type": "object",
"title": "UpdateCostMatrices",
"default": {},
"example": {
"cost_matrix": {
"1": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
1,
0
]
],
"2": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
2,
0
]
]
}
},
"nullable": true,
"properties": {
"data": {
"type": "object",
"title": "Data",
"nullable": true,
"description": "dtype : vehicle-type (uint8), cost (float32), cost >= 0.\n \n\n Sqaure matrix with cost to travel from A to B and B to A. \nIf there different types of vehicles which have different \ncost matrices, they can be provided with key value pair \nwhere key is vehicle-type and value is cost matrix. Value of \nvehicle type should be within [0, 255]",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
}
}
}
},
"cost_matrix": {
"type": "object",
"title": "Cost Matrix",
"nullable": true,
"deprecated": true,
"description": "This field is deprecated, please use the 'data' field instead",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
}
}
}
}
},
"x-examples": [
{
"cost_matrix": {
"1": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
1,
0
]
],
"2": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
2,
0
]
]
}
}
],
"description": "Sqaure matrix with cost to travel from A to B and B to A. \nIf there are different types of vehicles which have different \ncost matrices, they can be provided with key value pair \nwhere key is vehicle-type and value is cost matrix. Value of \nvehicle type should be within [0, 255]"
},
"travel_time_matrix_data": {
"type": "object",
"title": "UpdateCostMatrices",
"default": {},
"example": {
"cost_matrix": {
"1": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
1,
0
]
],
"2": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
2,
0
]
]
}
},
"nullable": true,
"properties": {
"data": {
"type": "object",
"title": "Data",
"nullable": true,
"description": "dtype : vehicle-type (uint8), cost (float32), cost >= 0.\n \n\n Sqaure matrix with cost to travel from A to B and B to A. \nIf there different types of vehicles which have different \ncost matrices, they can be provided with key value pair \nwhere key is vehicle-type and value is cost matrix. Value of \nvehicle type should be within [0, 255]",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
}
}
}
},
"cost_matrix": {
"type": "object",
"title": "Cost Matrix",
"nullable": true,
"deprecated": true,
"description": "This field is deprecated, please use the 'data' field instead",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
}
}
}
}
},
"x-examples": [
{
"cost_matrix": {
"1": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
1,
0
]
],
"2": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
2,
0
]
]
}
}
],
"description": "Sqaure matrix with time to travel from A to B and B to A. \nIf there are different types of vehicles which have different \ntravel time matrices, they can be provided with key value pair \nwhere key is vehicle-type and value is time matrix. Value of \nvehicle type should be within [0, 255]"
},
"cost_waypoint_graph_data": {
"type": "object",
"title": "UpdateWaypointGraphData",
"default": {},
"example": null,
"nullable": true,
"properties": {
"waypoint_graph": {
"type": "object",
"title": "Waypoint Graph",
"nullable": true,
"additionalProperties": {
"type": "object",
"title": "WaypointGraph",
"required": [
"edges",
"offsets"
],
"properties": {
"edges": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Edges",
"description": "dtype: int32, edge >= 0. \n\n Vertices of all the directed edges."
},
"offsets": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Offsets",
"description": "dtype: int32, offset >= 0. \n\n Offsets which provide number of edges from the source vertex signified by the index."
},
"weights": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Weights",
"nullable": true,
"description": "dtype: float32, weight >= 0. \n\n Weights of each edges."
}
}
}
}
},
"x-examples": [
null
],
"description": "Waypoint graph with weights as cost to travel from A to B \nand B to A. If there are different types of vehicles \nthey can be provided with key value pair \nwhere key is vehicle-type and value is the graph. Value of \nvehicle type should be within [0, 255]"
},
"travel_time_waypoint_graph_data": {
"type": "object",
"title": "UpdateWaypointGraphData",
"default": {},
"example": null,
"nullable": true,
"properties": {
"waypoint_graph": {
"type": "object",
"title": "Waypoint Graph",
"nullable": true,
"additionalProperties": {
"type": "object",
"title": "WaypointGraph",
"required": [
"edges",
"offsets"
],
"properties": {
"edges": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Edges",
"description": "dtype: int32, edge >= 0. \n\n Vertices of all the directed edges."
},
"offsets": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Offsets",
"description": "dtype: int32, offset >= 0. \n\n Offsets which provide number of edges from the source vertex signified by the index."
},
"weights": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Weights",
"nullable": true,
"description": "dtype: float32, weight >= 0. \n\n Weights of each edges."
}
}
}
}
},
"x-examples": [
null
],
"description": "Waypoint graph with weights as time to travel from A to B \nand B to A. If there are different types of vehicles \nthey can be provided with key value pair \nwhere key is vehicle-type and value is the graph. Value of \nvehicle type should be within [0, 255]"
}
}
}
OrderVehicleMatch
{
"type": "object",
"title": "OrderVehicleMatch",
"required": [
"order_id",
"vehicle_ids"
],
"properties": {
"order_id": {
"type": "integer",
"title": "Order Id",
"maximum": 2147483647,
"minimum": 0,
"description": "dtype: int32, order_id >= 0. \n\n Indices of orders which can be served by this particular vehicleOrder id as an integer"
},
"vehicle_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Vehicle Ids",
"description": "dtype: int32, vehicle_id >= 0. \n\n Indices of the vehicles which can serve this particular order. \n"
}
}
}
Output
{
"type": "object",
"title": "Output",
"required": [
"domain"
],
"properties": {
"domain": {
"anyOf": [
{
"$ref": "#/components/schemas/Window"
},
{
"$ref": "#/components/schemas/Global"
},
{
"$ref": "#/components/schemas/MultiPoint"
}
],
"title": "Domain"
},
"diagnostics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Diagnostic"
},
"title": "Diagnostics",
"default": [
{
"type": "control",
"channels": [],
"function": [],
"properties": {}
}
],
"maxItems": 10,
"minItems": 1
}
},
"description": "Base model to construct a domain.\n\nParameters\n----------\ndomain : Union[Window, Region, MultiPoint]\n Information about region geometry\ndiagnostics : List[Diagnostics]\n List of diagnostics."
}
OutputType
{
"type": "object",
"title": "OutputType",
"required": [
"extension",
"dtype"
],
"properties": {
"dtype": {
"type": "string",
"title": "Data Type",
"example": "uint8",
"x-examples": [
"uint8",
"uint16"
],
"description": "Output Data Type for segmentation mask"
},
"extension": {
"type": "string",
"title": "Extension",
"example": ".nii",
"x-examples": [
".nii",
".nrrd",
".nii.gz"
],
"description": "Supported ITK Extension for segmentation mask"
}
}
}
OutputTypeNullable
{
"type": "object",
"title": "Output Type",
"nullable": true,
"required": [
"extension",
"dtype"
],
"properties": {
"dtype": {
"type": "string",
"title": "Data Type",
"example": "uint8",
"x-examples": [
"uint8",
"uint16"
],
"description": "Output Data Type for segmentation mask"
},
"extension": {
"type": "string",
"title": "Extension",
"example": ".nii",
"x-examples": [
".nii",
".nrrd",
".nii.gz"
],
"description": "Supported ITK Extension for segmentation mask"
}
},
"description": "Provide any ITK output type for segmentation masks"
}
ParabricksFq2BamResponse
{
"type": "object",
"example": {},
"properties": {}
}
PaymentRequiredError
{
"type": "object",
"title": "PaymentRequiredError",
"properties": {
"detail": {
"type": "string",
"example": "You have reached your limit of credits.",
"description": "Contains specific information related to the error and why it occurred."
}
}
}
Prompts
{
"type": "object",
"title": "Prompts",
"properties": {
"points": {
"type": "object",
"title": "Click Points",
"default": [],
"example": {
"spleen": [
[
123,
212,
151
],
[
123,
212,
152
]
]
},
"nullable": true,
"x-examples": [
{
"spleen": [
[
123,
212,
151
],
[
123,
212,
152
]
]
}
],
"description": "User Click Points as prompts",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"maxItems": 3,
"minItems": 3,
"prefixItems": [
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
}
]
}
}
},
"classes": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Label Names/Indices",
"default": [],
"example": [
"spleen",
"liver"
],
"nullable": true,
"x-examples": [
[
"spleen",
"liver"
],
[
3,
1
]
],
"description": "Label Names/Indices as class prompts"
}
}
}
PromptsNullable
{
"type": "object",
"title": "Prompts",
"nullable": true,
"properties": {
"points": {
"type": "object",
"title": "Click Points",
"default": [],
"example": {
"spleen": [
[
123,
212,
151
],
[
123,
212,
152
]
]
},
"nullable": true,
"x-examples": [
{
"spleen": [
[
123,
212,
151
],
[
123,
212,
152
]
]
}
],
"description": "User Click Points as prompts",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"maxItems": 3,
"minItems": 3,
"prefixItems": [
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
}
]
}
}
},
"classes": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Label Names/Indices",
"default": [],
"example": [
"spleen",
"liver"
],
"nullable": true,
"x-examples": [
[
"spleen",
"liver"
],
[
3,
1
]
],
"description": "Label Names/Indices as class prompts"
}
},
"description": "User prompts for running Interactive Annotation"
}
ProteinStructurePredictRequest
{
"type": "object",
"title": "ProteinStructurePredictRequest",
"required": [
"sequence"
],
"properties": {
"sequence": {
"type": "string",
"title": "Amino acid sequence",
"pattern": "^[ARNDCQEGHILKMFPSTWYV]*$",
"maxLength": 1024,
"minLength": 1,
"description": "Amino acid sequence of a protein"
}
}
}
Rank
{
"type": "object",
"title": "Rank",
"required": [
"index",
"logit"
],
"properties": {
"index": {
"type": "integer",
"title": "Index",
"format": "int32",
"maximum": 512,
"minimum": 0
},
"logit": {
"type": "number",
"title": "Logit"
}
},
"description": "A single ranked text."
}
RankRequest
{
"type": "object",
"title": "RankRequest",
"required": [
"model",
"query",
"passages"
],
"properties": {
"model": {
"$ref": "#/components/schemas/ModelIdentifier",
"description": "Model identifier, must be nv-rerank-qa-mistral-4b:1"
},
"query": {
"$ref": "#/components/schemas/MultiModalData"
},
"passages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MultiModalData"
},
"title": "Passages",
"example": {
"text": "The Hopper GPU is paired with the Grace CPU using NVIDIA's ultra-fast chip-to-chip interconnect, delivering 900GB/s of bandwidth, 7X faster than PCIe Gen5. This innovative design will deliver up to 30X higher aggregate system memory bandwidth to the GPU compared to today's fastest servers and up to 10X higher performance for applications running terabytes of data."
},
"maxItems": 512,
"minItems": 1,
"x-examples": [
{
"text": "The Hopper GPU is paired with the Grace CPU using NVIDIA's ultra-fast chip-to-chip interconnect, delivering 900GB/s of bandwidth, 7X faster than PCIe Gen5. This innovative design will deliver up to 30X higher aggregate system memory bandwidth to the GPU compared to today's fastest servers and up to 10X higher performance for applications running terabytes of data."
},
{
"text": "A100 provides up to 20X higher performance over the prior generation and can be partitioned into seven GPU instances to dynamically adjust to shifting demands. The A100 80GB debuts the world's fastest memory bandwidth at over 2 terabytes per second (TB/s) to run the largest models and datasets."
},
{
"text": "Accelerated servers with H100 deliver the compute power—along with 3 terabytes per second (TB/s) of memory bandwidth per GPU and scalability with NVLink and NVSwitch™."
}
],
"description": "Text passages to rank based on the query"
}
},
"description": "A request to the rank endpoint.",
"x-konfig-properties": {
"query": {
"example": {
"text": "What is the GPU memory bandwidth of H100 SXM?"
},
"x-examples": [
{
"text": "What is the GPU memory bandwidth of H100 SXM?"
}
],
"description": "A text query for ranking the passages"
}
}
}
RankResponse
{
"type": "object",
"title": "RankResponse",
"required": [
"rankings"
],
"properties": {
"rankings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Rank"
},
"title": "Rankings",
"example": {
"index": 2,
"logit": 4.74609375
},
"maxItems": 512,
"minItems": 1,
"x-examples": [
{
"index": 2,
"logit": 4.74609375
},
{
"index": 1,
"logit": -6.11328125
},
{
"index": 0,
"logit": -7.25390625
}
]
}
},
"description": "A response from the rank endpoint."
}
ResponseConfig
{
"type": "object",
"title": "ResponseConfig",
"required": [
"response"
],
"properties": {
"response": {
"type": "string",
"title": "Response",
"format": "binary",
"maxLength": 88
}
},
"description": "Response schema."
}
ResponseModel
{
"type": "object",
"title": "ResponseModel",
"required": [
"response"
],
"properties": {
"notes": {
"type": "array",
"items": {
"type": "string"
},
"title": "Notes",
"default": [],
"description": "Any notes for users"
},
"response": {
"anyOf": [
{
"type": "object",
"title": "FeasibleSolve",
"properties": {
"perf_times": {
"type": "object",
"title": "Perf Times",
"nullable": true,
"description": "Etl and Solve times of the solve call"
},
"solver_response": {
"allOf": [
{
"type": "object",
"title": "FeasibleResultData",
"properties": {
"msg": {
"type": "string",
"title": "Msg",
"default": "",
"nullable": true,
"description": "Any information pertaining to the run."
},
"status": {
"type": "integer",
"title": "Status",
"default": 0,
"example": 0,
"maximum": 0,
"minimum": 0,
"x-examples": [
0
],
"description": "0 - Solution is available \n1 - Infeasible solution is available \n"
},
"num_vehicles": {
"type": "integer",
"title": "Num Vehicles",
"default": -1,
"example": 2,
"maximum": 2147483647,
"minimum": 0,
"x-examples": [
2
],
"description": "Number of vehicle being used for the solution"
},
"vehicle_data": {
"type": "object",
"title": "Vehicle Data",
"default": {},
"example": {
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
},
"x-examples": [
{
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
}
],
"description": "All the details of vehicle routes and timestamps",
"additionalProperties": {
"type": "object",
"title": "VehicleData",
"properties": {
"type": {
"type": "array",
"items": {
"enum": [
"Depot",
"Pickup",
"Delivery",
"Break",
"w"
],
"type": "string",
"title": "LocationTypeEnum"
},
"title": "Type",
"default": [],
"description": "Type of routing point, whether it is Depot, Waypoint - w \nDelivery, Break, Pickup \n"
},
"route": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Route",
"default": [],
"description": "Route indices as per waypoint graph or cost matrix provided"
},
"task_id": {
"type": "array",
"items": {
"type": "string"
},
"title": "Task Id",
"default": [],
"description": "task_ids being assigned to vehicle along with depot and breaks"
},
"arrival_stamp": {
"type": "array",
"items": {
"type": "number"
},
"title": "Arrival Stamp",
"default": [],
"description": "arrival stamps at each task locations"
}
}
}
},
"solution_cost": {
"type": "number",
"title": "Solution Cost",
"default": -1,
"example": 2,
"x-examples": [
2
],
"description": "Total cost of the solution"
}
}
}
],
"default": {
"msg": "",
"status": 0,
"num_vehicles": -1,
"vehicle_data": {},
"solution_cost": -1
},
"description": "Feasible solution"
}
}
},
{
"type": "object",
"title": "InFeasibleSolve",
"properties": {
"perf_times": {
"type": "object",
"title": "Perf Times",
"nullable": true,
"description": "Etl and Solve times of the solve call"
},
"solver_infeasible_response": {
"allOf": [
{
"type": "object",
"title": "InfeasibleResultData",
"properties": {
"msg": {
"type": "string",
"title": "Msg",
"default": "",
"nullable": true,
"description": "Any information pertaining to the run."
},
"status": {
"type": "integer",
"title": "Status",
"default": 1,
"example": 1,
"maximum": 1,
"minimum": 1,
"x-examples": [
1
],
"description": "1 - Infeasible solution is available \n"
},
"num_vehicles": {
"type": "integer",
"title": "Num Vehicles",
"default": -1,
"example": 2,
"maximum": 2147483647,
"minimum": 0,
"x-examples": [
2
],
"description": "Number of vehicle being used for the solution"
},
"vehicle_data": {
"type": "object",
"title": "Vehicle Data",
"default": {},
"example": {
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
},
"x-examples": [
{
"vehicle_data": {
"veh-1": {
"type": [
"Break",
"Delivery"
],
"route": [
1,
1
],
"task_id": [
"Break",
"Task-A"
],
"arrival_stamp": [
1,
2
]
},
"veh-2": {
"type": [
"Depot",
"Break",
"Delivery",
"Depot"
],
"route": [
0,
0,
2,
0
],
"task_id": [
"Depot",
"Break",
"Task-B",
"Depot"
],
"arrival_stamp": [
2,
2,
4,
5
]
}
}
}
],
"description": "All the details of vehicle routes and timestamps",
"additionalProperties": {
"type": "object",
"title": "VehicleData",
"properties": {
"type": {
"type": "array",
"items": {
"enum": [
"Depot",
"Pickup",
"Delivery",
"Break",
"w"
],
"type": "string",
"title": "LocationTypeEnum"
},
"title": "Type",
"default": [],
"description": "Type of routing point, whether it is Depot, Waypoint - w \nDelivery, Break, Pickup \n"
},
"route": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Route",
"default": [],
"description": "Route indices as per waypoint graph or cost matrix provided"
},
"task_id": {
"type": "array",
"items": {
"type": "string"
},
"title": "Task Id",
"default": [],
"description": "task_ids being assigned to vehicle along with depot and breaks"
},
"arrival_stamp": {
"type": "array",
"items": {
"type": "number"
},
"title": "Arrival Stamp",
"default": [],
"description": "arrival stamps at each task locations"
}
}
}
},
"solution_cost": {
"type": "number",
"title": "Solution Cost",
"default": -1,
"example": 2,
"x-examples": [
2
],
"description": "Total cost of the solution"
}
}
}
],
"default": {
"msg": "",
"status": 1,
"num_vehicles": -1,
"vehicle_data": {},
"solution_cost": -1
},
"description": "Infeasible solution, this can mean the problem itself is infeasible or solver requires more time to find a solution. Setting default solve time is suggested in case you are not aware of the expected time."
}
}
}
],
"title": "Response",
"description": "Response"
},
"warnings": {
"type": "array",
"items": {
"type": "string"
},
"title": "Warnings",
"default": [],
"description": "List of warnings for users to handle issues"
}
}
}
SimulationParameters
{
"type": "object",
"title": "SimulationParameters",
"required": [
"inference_model",
"initial_time"
],
"properties": {
"example": {
"initial_time": "2018-01-01T00:00:00",
"inference_model": "sfno_73ch",
"simulation_length": 20,
"number_of_ensembles": 1
},
"random_seed": {
"type": "integer",
"title": "Random Seed",
"format": "int32",
"default": 0,
"maximum": 2147483647,
"minimum": 0
},
"initial_time": {
"type": "string",
"title": "Initial Time",
"format": "date-time",
"maxLength": 19
},
"io_frequency": {
"type": "integer",
"title": "Io Frequency",
"format": "int32",
"default": 1,
"maximum": 120,
"minimum": 1
},
"output_format": {
"$ref": "#/components/schemas/IOEnum"
},
"inference_model": {
"$ref": "#/components/schemas/InferenceModels"
},
"simulation_length": {
"type": "integer",
"title": "Simulation Length",
"format": "int32",
"default": 20,
"maximum": 120,
"minimum": 0
},
"initial_output_time": {
"type": "integer",
"title": "Initial Output Time",
"format": "int32",
"default": 0,
"maximum": 120,
"minimum": 0
},
"number_of_ensembles": {
"type": "integer",
"title": "Number Of Ensembles",
"format": "int32",
"default": 1,
"maximum": 64,
"minimum": 1
},
"perturbation_method": {
"anyOf": [
{
"$ref": "#/components/schemas/NoPerturb"
},
{
"$ref": "#/components/schemas/BrownNoise"
},
{
"$ref": "#/components/schemas/BredVector"
},
{
"$ref": "#/components/schemas/SphericalGaussian"
},
{
"$ref": "#/components/schemas/ChannelAdjust"
}
],
"title": "Perturbation Method",
"default": {
"type": "BredVector",
"noise_amplitude": 0.05,
"ensemble_perturb": false,
"integration_steps": 20
}
},
"return_control_forecast": {
"type": "boolean",
"title": "Return Control Forecast",
"default": true
}
},
"description": "Parameters required to construct simulation.\n\nParameters\n----------\ninference_model : InferenceModel\n Model to use in the simulation.\ninitial_time : datetime.datetime, optional\n t = 0, used to define the initial condition. If not provided,\n defaults to the nearest 6 hour UTC time.\nsimulation_length : int\n How many 6-hour integration steps to simulate.\ninitial_output_time : int = 0\n The first time step to include in the output file.\nio_frequency : int = 1\n The frequency of times to include in the output file.\nreturn_control_forecast: bool = True\n Whether to return the deterministic control forecast\nnumber_of_ensembles : int\n The total number of ensemble members generated.\nperturbation_method : PertubationMethod\n The method used to perturb the initial conditions to create an ensemble.\nrandom_seed: int\n The random seed to set for randomness during perturbations.\noutput_format: str = ['zarr', 'netcdf', 'h5']\n The output file format.",
"x-konfig-properties": {
"output_format": {
"default": "netcdf"
}
}
}
SphericalGaussian
{
"type": "object",
"title": "SphericalGaussian",
"properties": {
"tau": {
"type": "number",
"title": "Tau",
"default": 3
},
"type": {
"const": "SphericalGaussian",
"title": "Type",
"default": "SphericalGaussian"
},
"alpha": {
"type": "number",
"title": "Alpha",
"default": 2
},
"sigma": {
"type": "number",
"title": "Sigma",
"nullable": true
},
"noise_amplitude": {
"type": "number",
"title": "Noise Amplitude",
"default": 0.05
}
},
"description": "Base model for holding parameter information for Spherical Gaussian perturbation\nmethod.\n\nParameters\n----------\nalpha : float, default is 2\n Regularity parameter. Larger means smoother.\ntau : float, default is 3\n Lenght-scale parameter. Larger means more scales.\nsigma : float, default is None\n Scale parameter. Larger means bigger.\n If None, sigma = tau**(0.5*(2*alpha - 2.0)).\nnoise_amplitude : float, default is 0.05\n Noise amplitude."
}
TaskData
{
"type": "object",
"title": "TaskData",
"required": [
"task_locations"
],
"properties": {
"demand": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Demand",
"example": [
[
1,
1
],
[
3,
1
]
],
"nullable": true,
"x-examples": [
[
[
1,
1
],
[
3,
1
]
]
],
"description": "dtype: int32 \n\n Note: For this release number of demand dimensions are limited to 3. \n\n Lists of demands of each tasks.\nMultiple demands can be added and each list represents one kind of demand. Order of these demands should match the type of vehicle capacities provided.Example: In case of two sets of demands per vehicle with 3 vehicles, \n\n [ \n\n [dem_1_tsk_1, dem_1_tsk_2, dem_1_tsk_3], \n\n [dem_2_tsk_1, dem_2_tsk_2, dem_2_tsk_3] \n\n ]"
},
"prizes": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Prizes",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "dtype: float32, prizes >= 0. \n\n List of values which signifies prizes that are collected for fulfilling each task. This can be used effectively in case solution is infeasible and need to drop few tasks to get feasible solution. Solver will prioritize for higher prize tasks "
},
"task_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Task Ids",
"example": [
"Task-A",
"Task-B"
],
"nullable": true,
"x-examples": [
[
"Task-A",
"Task-B"
]
],
"description": "List of the task ids or names provided as a string."
},
"service_times": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
{
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "integer"
}
}
}
],
"title": "Service Times",
"example": [
0,
0
],
"nullable": true,
"x-examples": [
[
0,
0
]
],
"description": "dtype: int32, time >= 0. \n\n Service time for each task. Accepts a list of service times for all vehicles. In case of vehicle specific service times, accepts a dict with key as vehicle id and value as list of service times.Example schema: In case all vehicles have same service times, \n\n [tsk_1_srv_time, tsk_2_srv_time, tsk_3_srv_time] \n\n \n\n In case, there are 2 types of vehicle types and each of them have different service times, \n\n { \n\n type-1: [tsk_1_srv_time, tsk_3_srv_time, tsk_3_srv_time], \n\n type-2: [tsk_1_srv_time, tsk_3_srv_time, tsk_3_srv_time] \n\n }"
},
"task_locations": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Task Locations",
"example": [
1,
2
],
"x-examples": [
[
1,
2
]
],
"description": "dtype: int32, location >= 0. \n\n Location where the task has been requested."
},
"task_time_windows": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Task Time Windows",
"example": [
[
0,
5
],
[
3,
9
]
],
"nullable": true,
"x-examples": [
[
[
0,
5
],
[
3,
9
]
]
],
"description": "dtype: int32, time >= 0. \n\n Earliest and Latest time windows for each tasks.\nFor example the data would look as follows, \n \n\n [ \n\n [tsk_1_earliest, tsk_1_latest], \n\n [tsk_2_earliest, tsk_2_latest] \n\n ]"
},
"mandatory_task_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Mandatory Task Ids",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "dtype: int32, mandatory_task_id >= 0. \n\n Note: This is only effective when used along with drop infeasible option. \n\n A list of task ids which are mandatory and solver would fail if these cannot be fulfilled."
},
"order_vehicle_match": {
"type": "array",
"items": {
"type": "object",
"title": "OrderVehicleMatch",
"required": [
"order_id",
"vehicle_ids"
],
"properties": {
"order_id": {
"type": "integer",
"title": "Order Id",
"maximum": 2147483647,
"minimum": 0,
"description": "dtype: int32, order_id >= 0. \n\n Indices of orders which can be served by this particular vehicleOrder id as an integer"
},
"vehicle_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Vehicle Ids",
"description": "dtype: int32, vehicle_id >= 0. \n\n Indices of the vehicles which can serve this particular order. \n"
}
}
},
"title": "Order Vehicle Match",
"example": [
{
"order_id": 0,
"vehicle_ids": [
0
]
},
{
"order_id": 1,
"vehicle_ids": [
1
]
}
],
"nullable": true,
"x-examples": [
[
{
"order_id": 0,
"vehicle_ids": [
0
]
},
{
"order_id": 1,
"vehicle_ids": [
1
]
}
]
],
"description": "A list of order vehicle match, where the match would contain a order id and a list of vehicle ids that can serve this order."
},
"pickup_and_delivery_pairs": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Pickup And Delivery Pairs",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "dtype: int32, pairs >= 0. \n\n List of Pick-up and delivery index pairs from task locations.\nIn case we have the following pick-up and delivery locations, 2->1, 4->5, 3->4, then task locations would look something like, task_locations = [0, 2, 1, 4, 5, 3, 4] and pick-up and delivery pairs would be index of those locations in task location and would look like [[1, 2], [3, 4], [5, 6]], 1 is pickup index for location 2 and it should be delivered to location 1 which is at index 2.Example schema: \n\n [ \n\n [pcikup_1_idx_to_task, drop_1_idx_to_task], \n\n [pcikup_2_idx_to_task, drop_2_idx_to_task], \n\n ]"
}
}
}
TextPrompt
{
"type": "object",
"title": "TextPrompt",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"title": "Text",
"example": "A photo of a Shiba Inu dog with a backpack riding a bike",
"x-examples": [
"A photo of a Shiba Inu dog with a backpack riding a bike"
],
"description": "The prompt itself"
},
"weight": {
"enum": [
1,
-1
],
"type": "number",
"title": "Weight",
"default": 1,
"maximum": 1,
"minimum": 1,
"description": "Weight of the prompt, only weight=1.0 for prompt and weight=-1 for negative prompt is supported"
}
}
}
UniversalVariantCallingBody
{
"type": "object",
"title": "UniversalVariantCallingBody",
"example": [
{
"mode": "shortread",
"in_bai": "",
"in_bam": "",
"use_gvcf": "False",
"out_stderr": "",
"out_stdout": "",
"out_variants": "",
"use_wes_model": "False",
"in_ref_tarball": "",
"additional_args": " --low-memory ",
"out_variants_parts_manifest": ""
}
],
"required": [
"in_ref_tarball",
"in_bam",
"in_bai",
"out_variants",
"out_variants_parts_manifest",
"out_stderr",
"out_stdout"
],
"properties": {
"mode": {
"type": "string",
"title": "DeepVariant Mode",
"default": "shortread",
"pattern": "shortread|ont|pacbio",
"description": "The sequencing read mode to use [shortread]."
},
"in_bai": {
"type": "string",
"title": "Input BAI file",
"minLength": 1,
"description": "A URL to the BAM index."
},
"in_bam": {
"type": "string",
"title": "Input BAM file",
"minLength": 1,
"description": "A URL to a BAM file."
},
"use_gvcf": {
"type": "boolean",
"title": "Output gVCF",
"default": false,
"description": "Output genomic VCF, rather than VCF."
},
"out_stderr": {
"type": "string",
"title": "Output STDERR URL",
"minLength": 1,
"description": "A presigned POST URL."
},
"out_stdout": {
"type": "string",
"title": "Output STDOUT URL",
"minLength": 1,
"description": "A presigned POST URL."
},
"out_variants": {
"type": "array",
"items": {
"type": "string"
},
"title": "Out VCF Presigned URL(s)",
"maxItems": 60,
"minItems": 1,
"description": "A list of presigned S3 URLs for file upload."
},
"use_wes_model": {
"type": "boolean",
"title": "Use WES Model",
"default": false,
"description": "Use the Whole Exome Model"
},
"in_ref_tarball": {
"type": "string",
"title": "Input Reference Tarball",
"pattern": ".*",
"minLength": 1,
"description": "A URL to a flat tarfile containing the reference genome and indices."
},
"additional_args": {
"type": "string",
"title": "Additonal arguments to Parabricks",
"default": "",
"minLength": 0
},
"out_variants_parts_manifest": {
"type": "string",
"title": "Output VCF File Parts Manifest",
"minLength": 0,
"description": "A single S3 presigned POST URL for the multipart signing manifest of out_variants."
}
}
}
UpdateCostMatrices
{
"type": "object",
"title": "UpdateCostMatrices",
"properties": {
"data": {
"type": "object",
"title": "Data",
"nullable": true,
"description": "dtype : vehicle-type (uint8), cost (float32), cost >= 0.\n \n\n Sqaure matrix with cost to travel from A to B and B to A. \nIf there different types of vehicles which have different \ncost matrices, they can be provided with key value pair \nwhere key is vehicle-type and value is cost matrix. Value of \nvehicle type should be within [0, 255]",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
}
}
}
},
"cost_matrix": {
"type": "object",
"title": "Cost Matrix",
"nullable": true,
"deprecated": true,
"description": "This field is deprecated, please use the 'data' field instead",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
}
}
}
}
}
}
UpdateSolverSettingsConfig
{
"type": "object",
"title": "UpdateSolverSettingsConfig",
"properties": {
"objectives": {
"type": "object",
"title": "Objective",
"nullable": true,
"properties": {
"cost": {
"type": "number",
"title": "Cost",
"example": 1,
"nullable": true,
"x-examples": [
1
],
"description": "dtype: float32. \n\n The weight assigned to minimizing the cost for a given solution, default value is 1"
},
"prize": {
"type": "number",
"title": "Prize",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the prize in accumulated prizes for each job fulfilled.This will be negated from overall values accumulated with other objectives.For example, if cost accumulated is 10 and objective value for it is 1, and if the prize accumulated is 3 and objective is 2, then total cost would look something like this 10 x 1 - 3 x 2 = 4."
},
"travel_time": {
"type": "number",
"title": "Travel Time",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to minimizing total travel time for a given solution (includes drive, service and wait time)"
},
"vehicle_fixed_cost": {
"type": "number",
"title": "Vehicle Fixed Cost",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the accumulated fixed costs of each vehicle used in solution"
},
"variance_route_size": {
"type": "number",
"title": "Variance Route Size",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the variance in the number of orders served by each route."
},
"variance_route_service_time": {
"type": "number",
"title": "Variance Route Service Time",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the variance in the accumulated service times of each route"
}
},
"description": "Values provided dictate the linear combination of factors used to evaluate solution quality.Only prize will be negated, all others gets accumulated. That's why sometime you might come across negative value as solution cost."
},
"time_limit": {
"type": "number",
"title": "Time Limit",
"example": 1,
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"x-examples": [
1
],
"description": "SolverSettings time limit"
},
"config_file": {
"type": "string",
"title": "Config File",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "Dump configuration information in a given file as yaml"
},
"verbose_mode": {
"type": "boolean",
"title": "Verbose Mode",
"default": false,
"nullable": true,
"description": "Displaying internal information during the solver execution."
},
"error_logging": {
"type": "boolean",
"title": "Error Logging",
"default": true,
"nullable": true,
"description": "Displaying constraint error information during the solver execution."
},
"drop_infeasible_tasks": {
"type": "boolean",
"title": "Drop Infeasible Tasks",
"default": false,
"nullable": true,
"description": "Note: Prize collection is recommend for finer control over \n\n what tasks would be picked or dropped. Drops infeasible tasks and returns routes for only feasible tasks. This should be used when solver fails to find a solution to fulfill all the tasks/order, "
}
}
}
UpdateWaypointGraphData
{
"type": "object",
"title": "UpdateWaypointGraphData",
"properties": {
"waypoint_graph": {
"type": "object",
"title": "Waypoint Graph",
"nullable": true,
"additionalProperties": {
"type": "object",
"title": "WaypointGraph",
"required": [
"edges",
"offsets"
],
"properties": {
"edges": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Edges",
"description": "dtype: int32, edge >= 0. \n\n Vertices of all the directed edges."
},
"offsets": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Offsets",
"description": "dtype: int32, offset >= 0. \n\n Offsets which provide number of edges from the source vertex signified by the index."
},
"weights": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Weights",
"nullable": true,
"description": "dtype: float32, weight >= 0. \n\n Weights of each edges."
}
}
}
}
}
}
Usage
{
"type": "object",
"title": "Usage",
"required": [
"completion_tokens",
"prompt_tokens",
"total_tokens"
],
"properties": {
"total_tokens": {
"type": "integer",
"title": "Total Tokens",
"example": 65,
"maximum": 4096,
"minimum": 0,
"x-examples": [
65
],
"description": "Total number of tokens used in the request (prompt + completion)."
},
"prompt_tokens": {
"type": "integer",
"title": "Prompt Tokens",
"example": 46,
"maximum": 3072,
"minimum": 0,
"x-examples": [
46
],
"description": "Number of tokens in the prompt."
},
"completion_tokens": {
"type": "integer",
"title": "Completion Tokens",
"example": 19,
"maximum": 1024,
"minimum": 0,
"x-examples": [
19
],
"description": "Number of tokens in the generated completion."
}
}
}
UsageInfo
{
"type": "object",
"title": "UsageInfo",
"properties": {
"total_tokens": {
"type": "integer",
"title": "Total Tokens",
"default": 0,
"description": "Total number of tokens used in the request (prompt + completion)."
},
"prompt_tokens": {
"type": "integer",
"title": "Prompt Tokens",
"default": 0,
"description": "Number of tokens in the prompt."
},
"completion_tokens": {
"type": "integer",
"title": "Completion Tokens",
"default": 0,
"nullable": true,
"description": "Number of tokens in the generated completion."
}
}
}
UserImageContent
{
"type": "object",
"title": "UserImageContent",
"required": [
"type",
"image_url"
],
"properties": {
"type": {
"const": "image_url",
"title": "Type",
"description": "The type of the content part."
},
"image_url": {
"type": "string",
"title": "Image Url",
"maxLength": 204800,
"description": "Base64 encoded image data in form of `data:image/{format};base64,{base64encodedimage}`. \n If the size of an image is more than 200KB, it needs to be uploaded to a presigned S3 bucket using NVCF Asset APIs.\n Once uploaded you can refer to it using the following format: `data:image/png;asset_id,{asset_id}`.\n Accepted formats are `jpg`, `png` and `jpeg`."
}
}
}
UserTextContent
{
"type": "object",
"title": "UserTextContent",
"required": [
"type",
"text"
],
"properties": {
"text": {
"type": "string",
"title": "Text",
"maxLength": 204800,
"description": "The text content."
},
"type": {
"const": "text",
"title": "Type",
"description": "The type of the content part."
}
}
}
ValidationError
{
"type": "object",
"title": "ValidationError",
"required": [
"loc",
"msg",
"type"
],
"properties": {
"loc": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"format": "bytes",
"maxLength": 88
},
{
"type": "integer",
"format": "int32",
"maximum": 1000,
"minimum": 0
}
]
},
"title": "Location",
"maxItems": 10
},
"msg": {
"type": "string",
"title": "Message",
"format": "bytes",
"maxLength": 88,
"description": "The error message."
},
"type": {
"type": "string",
"title": "Error Type",
"format": "bytes",
"maxLength": 88,
"description": "Error type"
}
}
}
VehicleData
{
"type": "object",
"title": "VehicleData",
"properties": {
"type": {
"type": "array",
"items": {
"enum": [
"Depot",
"Pickup",
"Delivery",
"Break",
"w"
],
"type": "string",
"title": "LocationTypeEnum"
},
"title": "Type",
"default": [],
"description": "Type of routing point, whether it is Depot, Waypoint - w \nDelivery, Break, Pickup \n"
},
"route": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Route",
"default": [],
"description": "Route indices as per waypoint graph or cost matrix provided"
},
"task_id": {
"type": "array",
"items": {
"type": "string"
},
"title": "Task Id",
"default": [],
"description": "task_ids being assigned to vehicle along with depot and breaks"
},
"arrival_stamp": {
"type": "array",
"items": {
"type": "number"
},
"title": "Arrival Stamp",
"default": [],
"description": "arrival stamps at each task locations"
}
}
}
VehicleOrderMatch
{
"type": "object",
"title": "VehicleOrderMatch",
"required": [
"vehicle_id",
"order_ids"
],
"properties": {
"order_ids": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Order Ids",
"description": "dtype: int32, order_id >= 0. \n\n Indices of orders which can be served by this particular vehicle"
},
"vehicle_id": {
"type": "integer",
"title": "Vehicle Id",
"maximum": 2147483647,
"minimum": 0,
"description": "dtype: int32, vehicle_id >= 0. \n\n Vehicle id as an integer, and can serve all the order listed in order_ids."
}
}
}
VideoRequest
{
"type": "object",
"title": "VideoRequest",
"required": [
"image"
],
"properties": {
"seed": {
"type": "integer",
"title": "Seed",
"default": 0,
"minimum": 0,
"description": "The seed which governs generation. Omit this option or use 0 for a random seed",
"exclusiveMaximum": 4294967296
},
"image": {
"type": "string",
"title": "Image",
"example": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAAEElEQVR4nGK6HcwNCAAA//8DTgE8HuxwEQAAAABJRU5ErkJggg==",
"x-examples": [
"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAAEElEQVR4nGK6HcwNCAAA//8DTgE8HuxwEQAAAABJRU5ErkJggg==",
"data:image/png;asset_id,5576911c-6031-47a4-8796-bb506b026ad0"
],
"description": "A base64-encoded string of the initial image that will be scaled to 1024x576. Images should be in form of `data:image/{format};base64,{base64encodedimage}` if it's smaller than 200KB. Otherwise, it needs to be uploaded to a presigned S3 bucket using NVCF Asset APIs.Once uploaded you can refer to it using the following format: `data:image/png;asset_id,{asset_id}`.Accepted formats are `jpg`, `png` and `jpeg`."
},
"cfg_scale": {
"type": "number",
"title": "Cfg Scale",
"default": 1.8,
"maximum": 9,
"description": "How strongly the video sticks to the original image. Use lower values to allow the model more freedom to make changes and higher values to correct motion distortions.",
"exclusiveMinimum": 1
},
"motion_bucket_id": {
"type": "integer",
"title": "Motion Bucket Id",
"default": 127,
"maximum": 127,
"minimum": 127,
"description": "Controls how much motion to add/remove from the image. Only motion_bucket_id=127 is supported"
}
}
}
VideoResponse
{
"type": "object",
"title": "VideoResponse",
"required": [
"video",
"finish_reason",
"seed"
],
"properties": {
"seed": {
"type": "integer",
"title": "Seed",
"description": "The seed used during generation"
},
"video": {
"type": "string",
"title": "Video",
"example": "/9j/4AAQSkZ...b+AVZ/9k=",
"x-examples": [
"/9j/4AAQSkZ...b+AVZ/9k="
],
"description": "A base64-encoded string of the generated video (mp4)"
},
"finish_reason": {
"$ref": "#/components/schemas/FinishReason"
}
},
"x-konfig-properties": {
"finish_reason": {
"description": "The result of the generation process. `SUCCESS` indicates success. `ERROR` indicates an error. `CONTENT_FILTERED` indicates the result affected by the content filter"
}
}
}
WaypointGraph
{
"type": "object",
"title": "WaypointGraph",
"required": [
"edges",
"offsets"
],
"properties": {
"edges": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Edges",
"description": "dtype: int32, edge >= 0. \n\n Vertices of all the directed edges."
},
"offsets": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Offsets",
"description": "dtype: int32, offset >= 0. \n\n Offsets which provide number of edges from the source vertex signified by the index."
},
"weights": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Weights",
"nullable": true,
"description": "dtype: float32, weight >= 0. \n\n Weights of each edges."
}
}
}
Window
{
"type": "object",
"title": "Window",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"title": "Name",
"pattern": "[A-Za-z\\s\\.]+",
"maxLength": 40
},
"type": {
"const": "Window",
"title": "Type",
"default": "Window"
},
"lat_max": {
"type": "number",
"title": "Lat Max",
"default": 90
},
"lat_min": {
"type": "number",
"title": "Lat Min",
"default": -90
},
"lon_max": {
"type": "number",
"title": "Lon Max",
"default": 360
},
"lon_min": {
"type": "number",
"title": "Lon Min",
"default": 0
}
},
"description": "Window domain, specifies a lat/lon rectangle.\n\nParameters\n----------\nlat_min : float\n Minimum latitude\nlon_min : float\n Maximum longitude\nlon_min : float\n Minimum longitude east\nlon_max : float\n Maximum longitude east\ndiagnostics : List[Diagnostic]\n List of diagnostics to be computed for this domain."
}
cuoptData
{
"type": "object",
"title": "cuoptData",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"title": "OptimizedRoutingData",
"nullable": true,
"required": [
"fleet_data",
"task_data"
],
"properties": {
"task_data": {
"allOf": [
{
"type": "object",
"title": "TaskData",
"required": [
"task_locations"
],
"properties": {
"demand": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Demand",
"example": [
[
1,
1
],
[
3,
1
]
],
"nullable": true,
"x-examples": [
[
[
1,
1
],
[
3,
1
]
]
],
"description": "dtype: int32 \n\n Note: For this release number of demand dimensions are limited to 3. \n\n Lists of demands of each tasks.\nMultiple demands can be added and each list represents one kind of demand. Order of these demands should match the type of vehicle capacities provided.Example: In case of two sets of demands per vehicle with 3 vehicles, \n\n [ \n\n [dem_1_tsk_1, dem_1_tsk_2, dem_1_tsk_3], \n\n [dem_2_tsk_1, dem_2_tsk_2, dem_2_tsk_3] \n\n ]"
},
"prizes": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Prizes",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "dtype: float32, prizes >= 0. \n\n List of values which signifies prizes that are collected for fulfilling each task. This can be used effectively in case solution is infeasible and need to drop few tasks to get feasible solution. Solver will prioritize for higher prize tasks "
},
"task_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Task Ids",
"example": [
"Task-A",
"Task-B"
],
"nullable": true,
"x-examples": [
[
"Task-A",
"Task-B"
]
],
"description": "List of the task ids or names provided as a string."
},
"service_times": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
{
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "integer"
}
}
}
],
"title": "Service Times",
"example": [
0,
0
],
"nullable": true,
"x-examples": [
[
0,
0
]
],
"description": "dtype: int32, time >= 0. \n\n Service time for each task. Accepts a list of service times for all vehicles. In case of vehicle specific service times, accepts a dict with key as vehicle id and value as list of service times.Example schema: In case all vehicles have same service times, \n\n [tsk_1_srv_time, tsk_2_srv_time, tsk_3_srv_time] \n\n \n\n In case, there are 2 types of vehicle types and each of them have different service times, \n\n { \n\n type-1: [tsk_1_srv_time, tsk_3_srv_time, tsk_3_srv_time], \n\n type-2: [tsk_1_srv_time, tsk_3_srv_time, tsk_3_srv_time] \n\n }"
},
"task_locations": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Task Locations",
"example": [
1,
2
],
"x-examples": [
[
1,
2
]
],
"description": "dtype: int32, location >= 0. \n\n Location where the task has been requested."
},
"task_time_windows": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Task Time Windows",
"example": [
[
0,
5
],
[
3,
9
]
],
"nullable": true,
"x-examples": [
[
[
0,
5
],
[
3,
9
]
]
],
"description": "dtype: int32, time >= 0. \n\n Earliest and Latest time windows for each tasks.\nFor example the data would look as follows, \n \n\n [ \n\n [tsk_1_earliest, tsk_1_latest], \n\n [tsk_2_earliest, tsk_2_latest] \n\n ]"
},
"mandatory_task_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Mandatory Task Ids",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "dtype: int32, mandatory_task_id >= 0. \n\n Note: This is only effective when used along with drop infeasible option. \n\n A list of task ids which are mandatory and solver would fail if these cannot be fulfilled."
},
"order_vehicle_match": {
"type": "array",
"items": {
"type": "object",
"title": "OrderVehicleMatch",
"required": [
"order_id",
"vehicle_ids"
],
"properties": {
"order_id": {
"type": "integer",
"title": "Order Id",
"maximum": 2147483647,
"minimum": 0,
"description": "dtype: int32, order_id >= 0. \n\n Indices of orders which can be served by this particular vehicleOrder id as an integer"
},
"vehicle_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Vehicle Ids",
"description": "dtype: int32, vehicle_id >= 0. \n\n Indices of the vehicles which can serve this particular order. \n"
}
}
},
"title": "Order Vehicle Match",
"example": [
{
"order_id": 0,
"vehicle_ids": [
0
]
},
{
"order_id": 1,
"vehicle_ids": [
1
]
}
],
"nullable": true,
"x-examples": [
[
{
"order_id": 0,
"vehicle_ids": [
0
]
},
{
"order_id": 1,
"vehicle_ids": [
1
]
}
]
],
"description": "A list of order vehicle match, where the match would contain a order id and a list of vehicle ids that can serve this order."
},
"pickup_and_delivery_pairs": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Pickup And Delivery Pairs",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "dtype: int32, pairs >= 0. \n\n List of Pick-up and delivery index pairs from task locations.\nIn case we have the following pick-up and delivery locations, 2->1, 4->5, 3->4, then task locations would look something like, task_locations = [0, 2, 1, 4, 5, 3, 4] and pick-up and delivery pairs would be index of those locations in task location and would look like [[1, 2], [3, 4], [5, 6]], 1 is pickup index for location 2 and it should be delivered to location 1 which is at index 2.Example schema: \n\n [ \n\n [pcikup_1_idx_to_task, drop_1_idx_to_task], \n\n [pcikup_2_idx_to_task, drop_2_idx_to_task], \n\n ]"
}
}
}
],
"description": "All Task information"
},
"fleet_data": {
"allOf": [
{
"type": "object",
"title": "FleetData",
"required": [
"vehicle_locations"
],
"properties": {
"capacities": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Capacities",
"example": [
[
2,
2
],
[
4,
1
]
],
"nullable": true,
"x-examples": [
[
[
2,
2
],
[
4,
1
]
]
],
"description": "dtype: int32, capacity >= 0. \n\n Note: For this release number of capacity dimensions are limited to 3. \n\n Lists of capacities of each vehicle.\nMultiple capacities can be added and each list will represent one kind of capacity. Order of kind of the capacities should match order of the demands.\nTotal capacity for each type should be sufficient to complete all demand of that type.Example: In case of two sets of capacities per vehicle with 3 vehicles, \n\n [ \n\n [cap_1_veh_1, cap_1_veh_2, cap_1_veh_3], \n\n [cap_2_veh_1, cap_2_veh_2, cap_2_veh_3] \n\n ]"
},
"priorities": {
"type": "array",
"items": {
"type": "integer",
"maximum": 255,
"minimum": 0
},
"title": "Priorities",
"example": [
0,
1
],
"nullable": true,
"x-examples": [
[
0,
1
]
],
"description": "dtype: int32 \n\n Priorities of each vehicle, lower the value higher the priority, value should be within [0, 255]"
},
"vehicle_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Vehicle Ids",
"example": [
"veh-1",
"veh-2"
],
"nullable": true,
"x-examples": [
[
"veh-1",
"veh-2"
]
],
"description": "List of the vehicle ids or names provided as a string."
},
"min_vehicles": {
"type": "integer",
"title": "Min Vehicles",
"example": 2,
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"x-examples": [
2
],
"description": "dtype: int32, min_vehicles >= 1. \n\n Solution should consider minimum number of vehicles"
},
"vehicle_types": {
"type": "array",
"items": {
"type": "integer",
"maximum": 255,
"minimum": 0
},
"title": "Vehicle Types",
"example": [
1,
2
],
"nullable": true,
"x-examples": [
[
1,
2
]
],
"description": "dtype: uint8. \n\n Types of vehicles in the fleet given as positive integers."
},
"skip_first_trips": {
"type": "array",
"items": {
"type": "boolean"
},
"title": "Skip First Trips",
"example": [
true,
false
],
"nullable": true,
"x-examples": [
[
true,
false
]
],
"description": "Drop the cost of trip to first location for that vehicle."
},
"drop_return_trips": {
"type": "array",
"items": {
"type": "boolean"
},
"title": "Drop Return Trips",
"example": [
true,
false
],
"nullable": true,
"x-examples": [
[
true,
false
]
],
"description": "Drop cost of return trip for each vehicle."
},
"vehicle_locations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Vehicle Locations",
"example": [
[
0,
0
],
[
0,
0
]
],
"x-examples": [
[
[
0,
0
],
[
0,
0
]
]
],
"description": "dtype: int32, vehicle_location >= 0. \n\n Start and end location of the vehicles in the given set of locations in WayPointGraph or CostMatrices.\nExample: For 2 vehicles, \n\n [ \n\n [veh_1_start_loc, veh_1_end_loc], \n\n [veh_2_start_loc, veh_2_end_loc] \n\n ]"
},
"vehicle_max_costs": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Vehicle Max Costs",
"example": [
7,
10
],
"nullable": true,
"x-examples": [
[
7,
10
]
],
"description": "dtype: float32, max_costs >= 0. \n\n Maximum cost a vehicle can incur and it is based on cost matrix/cost waypoint graph."
},
"vehicle_max_times": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Vehicle Max Times",
"example": [
7,
10
],
"nullable": true,
"x-examples": [
[
7,
10
]
],
"description": "dtype: float32, max_time >= 0. \n\n Maximum time a vehicle can operate (includes drive, service and wait time), this is based on travel time matrix/travel time waypoint graph."
},
"vehicle_fixed_costs": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Vehicle Fixed Costs",
"example": [
15,
5
],
"nullable": true,
"x-examples": [
[
15,
5
]
],
"description": "dtype: float32, fixed_cost >= 0. \n\n Cost of each vehicle.This helps in routing where may be 2 vehicles with less cost is effective compared to 1 vehicle with huge cost. As example shows veh-0 (15) > veh-1 (5) + veh-2 (5)"
},
"vehicle_order_match": {
"type": "array",
"items": {
"type": "object",
"title": "VehicleOrderMatch",
"required": [
"vehicle_id",
"order_ids"
],
"properties": {
"order_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Order Ids",
"description": "dtype: int32, order_id >= 0. \n\n Indices of orders which can be served by this particular vehicle"
},
"vehicle_id": {
"type": "integer",
"title": "Vehicle Id",
"maximum": 2147483647,
"minimum": 0,
"description": "dtype: int32, vehicle_id >= 0. \n\n Vehicle id as an integer, and can serve all the order listed in order_ids."
}
}
},
"title": "Vehicle Order Match",
"example": [
{
"order_ids": [
0
],
"vehicle_id": 0
},
{
"order_ids": [
1
],
"vehicle_id": 1
}
],
"nullable": true,
"x-examples": [
[
{
"order_ids": [
0
],
"vehicle_id": 0
},
{
"order_ids": [
1
],
"vehicle_id": 1
}
]
],
"description": "A list of vehicle order match, where the match would contain a vehicle id and a list of orders that vehicle can serve."
},
"vehicle_time_windows": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Vehicle Time Windows",
"example": [
[
0,
10
],
[
0,
10
]
],
"nullable": true,
"x-examples": [
[
[
0,
10
],
[
0,
10
]
]
],
"description": "dtype: int32, time >= 0. \n\n Earliest and Latest time window pairs for each vehicle,\nfor example the data would look as follows for 2 vehicles, \n \n\n [ \n\n [veh_1_earliest, veh_1_latest], \n\n [veh_2_earliest, veh_2_latest] \n\n ]"
},
"vehicle_break_durations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
},
"title": "Vehicle Break Durations",
"example": [
[
1,
1
]
],
"nullable": true,
"x-examples": [
[
[
1,
1
]
]
],
"description": "dtype: int32, time >= 0. \n\n Break duration for each vehicle. vehicle_break_time_windows should be provided to use this option.For example, in case of having 2 breaks for each vehicle, \n\n [ \n\n [brk_1_veh_1_duration, brk_1_veh_2_duration], \n\n [brk_2_veh_1_duration, brk_2_veh_2_duration], \n\n ]"
},
"vehicle_break_locations": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Vehicle Break Locations",
"example": [
0,
1
],
"nullable": true,
"x-examples": [
[
0,
1
]
],
"description": "dtype: int32, location >= 0. \n\n Break location where vehicles can take breaks. If not set, any location can be used for the break."
},
"vehicle_break_time_windows": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
}
}
},
"title": "Vehicle Break Time Windows",
"example": [
[
[
1,
2
],
[
2,
3
]
]
],
"nullable": true,
"x-examples": [
[
[
[
1,
2
],
[
2,
3
]
]
]
],
"description": "dtype: int32, time >= 0. \n\n Multiple break time windows can be added for each vehicle.Earliest and Latest break time window pairs for each vehicle,\nFor example, in case of 2 sets of breaks for each vehicle which translates to 2 dimensions of breaks,\n \n\n [ \n\n [[brk_1_veh_1_earliest, brk_1_veh_1_latest], [brk_1_veh_2_earliest, brk_1_veh_2_latest]] \n\n [[brk_2_veh_1_earliest, brk_2_veh_1_latest], [brk_2_veh_2_earliest, brk_2_veh_2_latest]] \n\n ] \n\n The break duration within this time window is provided through vehicle_break_durations."
}
}
}
],
"description": "All Fleet information"
},
"solver_config": {
"type": "object",
"title": "UpdateSolverSettingsConfig",
"nullable": true,
"properties": {
"objectives": {
"type": "object",
"title": "Objective",
"nullable": true,
"properties": {
"cost": {
"type": "number",
"title": "Cost",
"example": 1,
"nullable": true,
"x-examples": [
1
],
"description": "dtype: float32. \n\n The weight assigned to minimizing the cost for a given solution, default value is 1"
},
"prize": {
"type": "number",
"title": "Prize",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the prize in accumulated prizes for each job fulfilled.This will be negated from overall values accumulated with other objectives.For example, if cost accumulated is 10 and objective value for it is 1, and if the prize accumulated is 3 and objective is 2, then total cost would look something like this 10 x 1 - 3 x 2 = 4."
},
"travel_time": {
"type": "number",
"title": "Travel Time",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to minimizing total travel time for a given solution (includes drive, service and wait time)"
},
"vehicle_fixed_cost": {
"type": "number",
"title": "Vehicle Fixed Cost",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the accumulated fixed costs of each vehicle used in solution"
},
"variance_route_size": {
"type": "number",
"title": "Variance Route Size",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the variance in the number of orders served by each route."
},
"variance_route_service_time": {
"type": "number",
"title": "Variance Route Service Time",
"example": 0,
"nullable": true,
"x-examples": [
0
],
"description": "dtype: float32. \n\n The weight assigned to the variance in the accumulated service times of each route"
}
},
"description": "Values provided dictate the linear combination of factors used to evaluate solution quality.Only prize will be negated, all others gets accumulated. That's why sometime you might come across negative value as solution cost."
},
"time_limit": {
"type": "number",
"title": "Time Limit",
"example": 1,
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"x-examples": [
1
],
"description": "SolverSettings time limit"
},
"config_file": {
"type": "string",
"title": "Config File",
"example": null,
"nullable": true,
"x-examples": [
null
],
"description": "Dump configuration information in a given file as yaml"
},
"verbose_mode": {
"type": "boolean",
"title": "Verbose Mode",
"default": false,
"nullable": true,
"description": "Displaying internal information during the solver execution."
},
"error_logging": {
"type": "boolean",
"title": "Error Logging",
"default": true,
"nullable": true,
"description": "Displaying constraint error information during the solver execution."
},
"drop_infeasible_tasks": {
"type": "boolean",
"title": "Drop Infeasible Tasks",
"default": false,
"nullable": true,
"description": "Note: Prize collection is recommend for finer control over \n\n what tasks would be picked or dropped. Drops infeasible tasks and returns routes for only feasible tasks. This should be used when solver fails to find a solution to fulfill all the tasks/order, "
}
}
},
"cost_matrix_data": {
"type": "object",
"title": "UpdateCostMatrices",
"default": {},
"example": {
"cost_matrix": {
"1": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
1,
0
]
],
"2": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
2,
0
]
]
}
},
"nullable": true,
"properties": {
"data": {
"type": "object",
"title": "Data",
"nullable": true,
"description": "dtype : vehicle-type (uint8), cost (float32), cost >= 0.\n \n\n Sqaure matrix with cost to travel from A to B and B to A. \nIf there different types of vehicles which have different \ncost matrices, they can be provided with key value pair \nwhere key is vehicle-type and value is cost matrix. Value of \nvehicle type should be within [0, 255]",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
}
}
}
},
"cost_matrix": {
"type": "object",
"title": "Cost Matrix",
"nullable": true,
"deprecated": true,
"description": "This field is deprecated, please use the 'data' field instead",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
}
}
}
}
},
"x-examples": [
{
"cost_matrix": {
"1": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
1,
0
]
],
"2": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
2,
0
]
]
}
}
],
"description": "Sqaure matrix with cost to travel from A to B and B to A. \nIf there are different types of vehicles which have different \ncost matrices, they can be provided with key value pair \nwhere key is vehicle-type and value is cost matrix. Value of \nvehicle type should be within [0, 255]"
},
"travel_time_matrix_data": {
"type": "object",
"title": "UpdateCostMatrices",
"default": {},
"example": {
"cost_matrix": {
"1": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
1,
0
]
],
"2": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
2,
0
]
]
}
},
"nullable": true,
"properties": {
"data": {
"type": "object",
"title": "Data",
"nullable": true,
"description": "dtype : vehicle-type (uint8), cost (float32), cost >= 0.\n \n\n Sqaure matrix with cost to travel from A to B and B to A. \nIf there different types of vehicles which have different \ncost matrices, they can be provided with key value pair \nwhere key is vehicle-type and value is cost matrix. Value of \nvehicle type should be within [0, 255]",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
}
}
}
},
"cost_matrix": {
"type": "object",
"title": "Cost Matrix",
"nullable": true,
"deprecated": true,
"description": "This field is deprecated, please use the 'data' field instead",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
}
}
}
}
},
"x-examples": [
{
"cost_matrix": {
"1": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
1,
0
]
],
"2": [
[
0,
1,
1
],
[
1,
0,
1
],
[
1,
2,
0
]
]
}
}
],
"description": "Sqaure matrix with time to travel from A to B and B to A. \nIf there are different types of vehicles which have different \ntravel time matrices, they can be provided with key value pair \nwhere key is vehicle-type and value is time matrix. Value of \nvehicle type should be within [0, 255]"
},
"cost_waypoint_graph_data": {
"type": "object",
"title": "UpdateWaypointGraphData",
"default": {},
"example": null,
"nullable": true,
"properties": {
"waypoint_graph": {
"type": "object",
"title": "Waypoint Graph",
"nullable": true,
"additionalProperties": {
"type": "object",
"title": "WaypointGraph",
"required": [
"edges",
"offsets"
],
"properties": {
"edges": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Edges",
"description": "dtype: int32, edge >= 0. \n\n Vertices of all the directed edges."
},
"offsets": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Offsets",
"description": "dtype: int32, offset >= 0. \n\n Offsets which provide number of edges from the source vertex signified by the index."
},
"weights": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Weights",
"nullable": true,
"description": "dtype: float32, weight >= 0. \n\n Weights of each edges."
}
}
}
}
},
"x-examples": [
null
],
"description": "Waypoint graph with weights as cost to travel from A to B \nand B to A. If there are different types of vehicles \nthey can be provided with key value pair \nwhere key is vehicle-type and value is the graph. Value of \nvehicle type should be within [0, 255]"
},
"travel_time_waypoint_graph_data": {
"type": "object",
"title": "UpdateWaypointGraphData",
"default": {},
"example": null,
"nullable": true,
"properties": {
"waypoint_graph": {
"type": "object",
"title": "Waypoint Graph",
"nullable": true,
"additionalProperties": {
"type": "object",
"title": "WaypointGraph",
"required": [
"edges",
"offsets"
],
"properties": {
"edges": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Edges",
"description": "dtype: int32, edge >= 0. \n\n Vertices of all the directed edges."
},
"offsets": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0
},
"title": "Offsets",
"description": "dtype: int32, offset >= 0. \n\n Offsets which provide number of edges from the source vertex signified by the index."
},
"weights": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"title": "Weights",
"nullable": true,
"description": "dtype: float32, weight >= 0. \n\n Weights of each edges."
}
}
}
}
},
"x-examples": [
null
],
"description": "Waypoint graph with weights as time to travel from A to B \nand B to A. If there are different types of vehicles \nthey can be provided with key value pair \nwhere key is vehicle-type and value is the graph. Value of \nvehicle type should be within [0, 255]"
}
},
"description": "The data that needs to be processed by the service. For detailed explanations of each field, please consult the following link: <a href=\"https://docs.nvidia.com/cuopt/service/latest/data-requirements.html\">data requirements</a> . To ensure best practices, please refer to: <a href=\"https://docs.nvidia.com/cuopt/service/latest/best-practices.html\">best practices</a>. For examples, you can find them at: <a href=\"https://github.com/NVIDIA/cuOpt-Resources/tree/branch-23.10/notebooks/routing/service\">notebooks</a>. If the size of the data exceeds 250KB, please utilize the large assets API to upload it to s3. In such cases, set the data as null and include the header NVCF-INPUT-ASSET-REFERENCES: $ASSET_ID in the POST request."
},
"action": {
"enum": [
"cuOpt_OptimizedRouting",
"cuOpt_RoutingValidator",
"0"
],
"type": "string",
"title": "Action",
"default": "cuOpt_OptimizedRouting",
"nullable": true,
"description": "Action to be performed by the service, validator action just validates input against format and base rules."
},
"parameters": {
"type": "object",
"title": "Parameters",
"nullable": true,
"description": "unused/ignored but retained for compatibility"
},
"client_version": {
"type": "string",
"title": "Client Version",
"default": "",
"nullable": true,
"description": "cuOpt client version. Set to 'custom' to skip version check."
}
}
}