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 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)