TypesΒΆ

pydantic model mlserver.types.InferenceErrorResponseΒΆ

Show JSON schema
{
   "title": "InferenceErrorResponse",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "error": {
         "title": "Error",
         "type": "string"
      }
   }
}

Fields:
  • error (str | None)

field error: str | None = NoneΒΆ
pydantic model mlserver.types.InferenceRequestΒΆ

Show JSON schema
{
   "title": "InferenceRequest",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "string"
      },
      "parameters": {
         "$ref": "#/definitions/Parameters"
      },
      "inputs": {
         "title": "Inputs",
         "type": "array",
         "items": {
            "$ref": "#/definitions/RequestInput"
         }
      },
      "outputs": {
         "title": "Outputs",
         "type": "array",
         "items": {
            "$ref": "#/definitions/RequestOutput"
         }
      }
   },
   "required": [
      "inputs"
   ],
   "definitions": {
      "Parameters": {
         "title": "Parameters",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
         "type": "object",
         "properties": {
            "content_type": {
               "title": "Content Type",
               "type": "string"
            },
            "headers": {
               "title": "Headers",
               "type": "object"
            }
         }
      },
      "TensorData": {
         "title": "TensorData",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525"
      },
      "RequestInput": {
         "title": "RequestInput",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "shape": {
               "title": "Shape",
               "type": "array",
               "items": {
                  "type": "integer"
               }
            },
            "datatype": {
               "title": "Datatype",
               "type": "string"
            },
            "parameters": {
               "$ref": "#/definitions/Parameters"
            },
            "data": {
               "$ref": "#/definitions/TensorData"
            }
         },
         "required": [
            "name",
            "shape",
            "datatype",
            "data"
         ]
      },
      "RequestOutput": {
         "title": "RequestOutput",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "parameters": {
               "$ref": "#/definitions/Parameters"
            }
         },
         "required": [
            "name"
         ]
      }
   }
}

Fields:
  • id (str | None)

  • inputs (List[mlserver.types.dataplane.RequestInput])

  • outputs (List[mlserver.types.dataplane.RequestOutput] | None)

  • parameters (mlserver.types.dataplane.Parameters | None)

field id: str | None = NoneΒΆ
field inputs: List[RequestInput] [Required]ΒΆ
field outputs: List[RequestOutput] | None = NoneΒΆ
field parameters: Parameters | None = NoneΒΆ
pydantic model mlserver.types.InferenceResponseΒΆ

Show JSON schema
{
   "title": "InferenceResponse",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "model_name": {
         "title": "Model Name",
         "type": "string"
      },
      "model_version": {
         "title": "Model Version",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "parameters": {
         "$ref": "#/definitions/Parameters"
      },
      "outputs": {
         "title": "Outputs",
         "type": "array",
         "items": {
            "$ref": "#/definitions/ResponseOutput"
         }
      }
   },
   "required": [
      "model_name",
      "outputs"
   ],
   "definitions": {
      "Parameters": {
         "title": "Parameters",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
         "type": "object",
         "properties": {
            "content_type": {
               "title": "Content Type",
               "type": "string"
            },
            "headers": {
               "title": "Headers",
               "type": "object"
            }
         }
      },
      "TensorData": {
         "title": "TensorData",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525"
      },
      "ResponseOutput": {
         "title": "ResponseOutput",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "shape": {
               "title": "Shape",
               "type": "array",
               "items": {
                  "type": "integer"
               }
            },
            "datatype": {
               "title": "Datatype",
               "type": "string"
            },
            "parameters": {
               "$ref": "#/definitions/Parameters"
            },
            "data": {
               "$ref": "#/definitions/TensorData"
            }
         },
         "required": [
            "name",
            "shape",
            "datatype",
            "data"
         ]
      }
   }
}

Fields:
  • id (str | None)

  • model_name (str)

  • model_version (str | None)

  • outputs (List[mlserver.types.dataplane.ResponseOutput])

  • parameters (mlserver.types.dataplane.Parameters | None)

field id: str | None = NoneΒΆ
field model_name: str [Required]ΒΆ
field model_version: str | None = NoneΒΆ
field outputs: List[ResponseOutput] [Required]ΒΆ
field parameters: Parameters | None = NoneΒΆ
pydantic model mlserver.types.MetadataModelErrorResponseΒΆ

Show JSON schema
{
   "title": "MetadataModelErrorResponse",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "error": {
         "title": "Error",
         "type": "string"
      }
   },
   "required": [
      "error"
   ]
}

Fields:
  • error (str)

field error: str [Required]ΒΆ
pydantic model mlserver.types.MetadataModelResponseΒΆ

Show JSON schema
{
   "title": "MetadataModelResponse",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "versions": {
         "title": "Versions",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "platform": {
         "title": "Platform",
         "type": "string"
      },
      "inputs": {
         "title": "Inputs",
         "type": "array",
         "items": {
            "$ref": "#/definitions/MetadataTensor"
         }
      },
      "outputs": {
         "title": "Outputs",
         "type": "array",
         "items": {
            "$ref": "#/definitions/MetadataTensor"
         }
      },
      "parameters": {
         "$ref": "#/definitions/Parameters"
      }
   },
   "required": [
      "name",
      "platform"
   ],
   "definitions": {
      "Parameters": {
         "title": "Parameters",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
         "type": "object",
         "properties": {
            "content_type": {
               "title": "Content Type",
               "type": "string"
            },
            "headers": {
               "title": "Headers",
               "type": "object"
            }
         }
      },
      "MetadataTensor": {
         "title": "MetadataTensor",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "datatype": {
               "title": "Datatype",
               "type": "string"
            },
            "shape": {
               "title": "Shape",
               "type": "array",
               "items": {
                  "type": "integer"
               }
            },
            "parameters": {
               "$ref": "#/definitions/Parameters"
            }
         },
         "required": [
            "name",
            "datatype",
            "shape"
         ]
      }
   }
}

Fields:
  • inputs (List[mlserver.types.dataplane.MetadataTensor] | None)

  • name (str)

  • outputs (List[mlserver.types.dataplane.MetadataTensor] | None)

  • parameters (mlserver.types.dataplane.Parameters | None)

  • platform (str)

  • versions (List[str] | None)

field inputs: List[MetadataTensor] | None = NoneΒΆ
field name: str [Required]ΒΆ
field outputs: List[MetadataTensor] | None = NoneΒΆ
field parameters: Parameters | None = NoneΒΆ
field platform: str [Required]ΒΆ
field versions: List[str] | None = NoneΒΆ
pydantic model mlserver.types.MetadataServerErrorResponseΒΆ

Show JSON schema
{
   "title": "MetadataServerErrorResponse",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "error": {
         "title": "Error",
         "type": "string"
      }
   },
   "required": [
      "error"
   ]
}

Fields:
  • error (str)

field error: str [Required]ΒΆ
pydantic model mlserver.types.MetadataServerResponseΒΆ

Show JSON schema
{
   "title": "MetadataServerResponse",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "version": {
         "title": "Version",
         "type": "string"
      },
      "extensions": {
         "title": "Extensions",
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   },
   "required": [
      "name",
      "version",
      "extensions"
   ]
}

Fields:
  • extensions (List[str])

  • name (str)

  • version (str)

field extensions: List[str] [Required]ΒΆ
field name: str [Required]ΒΆ
field version: str [Required]ΒΆ
pydantic model mlserver.types.MetadataTensorΒΆ

Show JSON schema
{
   "title": "MetadataTensor",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "datatype": {
         "title": "Datatype",
         "type": "string"
      },
      "shape": {
         "title": "Shape",
         "type": "array",
         "items": {
            "type": "integer"
         }
      },
      "parameters": {
         "$ref": "#/definitions/Parameters"
      }
   },
   "required": [
      "name",
      "datatype",
      "shape"
   ],
   "definitions": {
      "Parameters": {
         "title": "Parameters",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
         "type": "object",
         "properties": {
            "content_type": {
               "title": "Content Type",
               "type": "string"
            },
            "headers": {
               "title": "Headers",
               "type": "object"
            }
         }
      }
   }
}

Fields:
  • datatype (str)

  • name (str)

  • parameters (mlserver.types.dataplane.Parameters | None)

  • shape (List[int])

field datatype: str [Required]ΒΆ
field name: str [Required]ΒΆ
field parameters: Parameters | None = NoneΒΆ
field shape: List[int] [Required]ΒΆ
pydantic model mlserver.types.ParametersΒΆ

Show JSON schema
{
   "title": "Parameters",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "content_type": {
         "title": "Content Type",
         "type": "string"
      },
      "headers": {
         "title": "Headers",
         "type": "object"
      }
   }
}

Config:
  • extra: Extra = allow

Fields:
  • content_type (str | None)

  • headers (Dict[str, Any] | None)

field content_type: str | None = NoneΒΆ
field headers: Dict[str, Any] | None = NoneΒΆ
pydantic model mlserver.types.RepositoryIndexRequestΒΆ

Show JSON schema
{
   "title": "RepositoryIndexRequest",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "ready": {
         "title": "Ready",
         "type": "boolean"
      }
   }
}

Fields:
  • ready (bool | None)

field ready: bool | None = NoneΒΆ
pydantic model mlserver.types.RepositoryIndexResponseΒΆ

Show JSON schema
{
   "title": "RepositoryIndexResponse",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "array",
   "items": {
      "$ref": "#/definitions/RepositoryIndexResponseItem"
   },
   "definitions": {
      "State": {
         "title": "State",
         "description": "An enumeration.",
         "enum": [
            "UNKNOWN",
            "READY",
            "UNAVAILABLE",
            "LOADING",
            "UNLOADING"
         ]
      },
      "RepositoryIndexResponseItem": {
         "title": "RepositoryIndexResponseItem",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "version": {
               "title": "Version",
               "type": "string"
            },
            "state": {
               "$ref": "#/definitions/State"
            },
            "reason": {
               "title": "Reason",
               "type": "string"
            }
         },
         "required": [
            "name",
            "state",
            "reason"
         ]
      }
   }
}

Fields:
  • __root__ (List[mlserver.types.model_repository.RepositoryIndexResponseItem])

pydantic model mlserver.types.RepositoryIndexResponseItemΒΆ

Show JSON schema
{
   "title": "RepositoryIndexResponseItem",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "version": {
         "title": "Version",
         "type": "string"
      },
      "state": {
         "$ref": "#/definitions/State"
      },
      "reason": {
         "title": "Reason",
         "type": "string"
      }
   },
   "required": [
      "name",
      "state",
      "reason"
   ],
   "definitions": {
      "State": {
         "title": "State",
         "description": "An enumeration.",
         "enum": [
            "UNKNOWN",
            "READY",
            "UNAVAILABLE",
            "LOADING",
            "UNLOADING"
         ]
      }
   }
}

Fields:
  • name (str)

  • reason (str)

  • state (mlserver.types.model_repository.State)

  • version (str | None)

field name: str [Required]ΒΆ
field reason: str [Required]ΒΆ
field state: State [Required]ΒΆ
field version: str | None = NoneΒΆ
pydantic model mlserver.types.RepositoryLoadErrorResponseΒΆ

Show JSON schema
{
   "title": "RepositoryLoadErrorResponse",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "error": {
         "title": "Error",
         "type": "string"
      }
   }
}

Fields:
  • error (str | None)

field error: str | None = NoneΒΆ
pydantic model mlserver.types.RepositoryUnloadErrorResponseΒΆ

Show JSON schema
{
   "title": "RepositoryUnloadErrorResponse",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "error": {
         "title": "Error",
         "type": "string"
      }
   }
}

Fields:
  • error (str | None)

field error: str | None = NoneΒΆ
pydantic model mlserver.types.RequestInputΒΆ

Show JSON schema
{
   "title": "RequestInput",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "shape": {
         "title": "Shape",
         "type": "array",
         "items": {
            "type": "integer"
         }
      },
      "datatype": {
         "title": "Datatype",
         "type": "string"
      },
      "parameters": {
         "$ref": "#/definitions/Parameters"
      },
      "data": {
         "$ref": "#/definitions/TensorData"
      }
   },
   "required": [
      "name",
      "shape",
      "datatype",
      "data"
   ],
   "definitions": {
      "Parameters": {
         "title": "Parameters",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
         "type": "object",
         "properties": {
            "content_type": {
               "title": "Content Type",
               "type": "string"
            },
            "headers": {
               "title": "Headers",
               "type": "object"
            }
         }
      },
      "TensorData": {
         "title": "TensorData",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525"
      }
   }
}

Fields:
  • data (mlserver.types.dataplane.TensorData)

  • datatype (str)

  • name (str)

  • parameters (mlserver.types.dataplane.Parameters | None)

  • shape (List[int])

field data: TensorData [Required]ΒΆ
field datatype: str [Required]ΒΆ
field name: str [Required]ΒΆ
field parameters: Parameters | None = NoneΒΆ
field shape: List[int] [Required]ΒΆ
pydantic model mlserver.types.RequestOutputΒΆ

Show JSON schema
{
   "title": "RequestOutput",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "parameters": {
         "$ref": "#/definitions/Parameters"
      }
   },
   "required": [
      "name"
   ],
   "definitions": {
      "Parameters": {
         "title": "Parameters",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
         "type": "object",
         "properties": {
            "content_type": {
               "title": "Content Type",
               "type": "string"
            },
            "headers": {
               "title": "Headers",
               "type": "object"
            }
         }
      }
   }
}

Fields:
  • name (str)

  • parameters (mlserver.types.dataplane.Parameters | None)

field name: str [Required]ΒΆ
field parameters: Parameters | None = NoneΒΆ
pydantic model mlserver.types.ResponseOutputΒΆ

Show JSON schema
{
   "title": "ResponseOutput",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "shape": {
         "title": "Shape",
         "type": "array",
         "items": {
            "type": "integer"
         }
      },
      "datatype": {
         "title": "Datatype",
         "type": "string"
      },
      "parameters": {
         "$ref": "#/definitions/Parameters"
      },
      "data": {
         "$ref": "#/definitions/TensorData"
      }
   },
   "required": [
      "name",
      "shape",
      "datatype",
      "data"
   ],
   "definitions": {
      "Parameters": {
         "title": "Parameters",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525",
         "type": "object",
         "properties": {
            "content_type": {
               "title": "Content Type",
               "type": "string"
            },
            "headers": {
               "title": "Headers",
               "type": "object"
            }
         }
      },
      "TensorData": {
         "title": "TensorData",
         "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525"
      }
   }
}

Fields:
  • data (mlserver.types.dataplane.TensorData)

  • datatype (str)

  • name (str)

  • parameters (mlserver.types.dataplane.Parameters | None)

  • shape (List[int])

field data: TensorData [Required]ΒΆ
field datatype: str [Required]ΒΆ
field name: str [Required]ΒΆ
field parameters: Parameters | None = NoneΒΆ
field shape: List[int] [Required]ΒΆ
class mlserver.types.State(value)ΒΆ

An enumeration.

pydantic model mlserver.types.TensorDataΒΆ

Show JSON schema
{
   "title": "TensorData",
   "description": "Override Pydantic's BaseModel class to ensure all payloads exclude unset\nfields by default.\n\nFrom:\n    https://github.com/pydantic/pydantic/issues/1387#issuecomment-612901525"
}

Fields:
  • __root__ (Any)