Get VirtualModel

GET

https://host.com/apis/inference-gateway/v2/workspaces/:workspace/virtual-models/:name

GET

/apis/inference-gateway/v2/workspaces/:workspace/virtual-models/:name

$ curl https://host.com/apis/inference-gateway/v2/workspaces/workspace/virtual-models/name \
>      -H "Content-Type: application/json"

1 {
2   "workspace": "nemo-enterprise",
3   "id": "a3f47b9e-8c2d-4f1a-9b7e-2d3f5c6a7e8b",
4   "created_at": "2024-01-15T09:30:00Z",
5   "created_by": "admin@nemo-enterprise.com",
6   "updated_at": "2024-04-10T14:45:00Z",
7   "updated_by": "devops@nemo-enterprise.com",
8   "entity_id": "a3f47b9e-8c2d-4f1a-9b7e-2d3f5c6a7e8b",
9   "parent": "nemo-enterprise/root-virtual-model",
10   "name": "customer-support-bot",
11   "project": "customer-engagement",
12   "default_model_entity": "nemo-enterprise/gpt-4-chat",
13   "autoprovisioned": false,
14   "models": [
15     {
16       "model": "nemo-enterprise/gpt-4-chat",
17       "backend_format": "OPENAI_CHAT"
18     }
19   ],
20   "request_middleware": [
21     {
22       "name": "nemo-authenticator",
23       "config_type": "auth_config",
24       "config": {
25         "token_header": "Authorization",
26         "token_prefix": "Bearer"
27       },
28       "config_id": ""
29     }
30   ],
31   "response_middleware": [
32     {
33       "name": "nemo-logger",
34       "config_type": "logging_config",
35       "config": {
36         "log_level": "INFO",
37         "log_format": "json"
38       },
39       "config_id": ""
40     }
41   ],
42   "post_response_middleware": [
43     {
44       "name": "nemo-metrics",
45       "config_type": "metrics_config",
46       "config": {
47         "enabled": true,
48         "metrics_endpoint": "/metrics"
49       },
50       "config_id": ""
51     }
52   ],
53   "override_proxy": "https://proxy.nemo-enterprise.com"
54 }

Get a VirtualModel by workspace and name.

Path parameters

workspacestringRequired

namestringRequired

Response

VirtualModel details

workspacestringformat: "^[\w\-\+.@:]+$"

Workspace identifier

idstringRead-only

created_atdatetimeRead-only

created_bystring or nullRead-only

updated_atdatetimeRead-only

updated_bystring or nullRead-only

entity_idstringRead-only

Alias for id for backwards compatibility.

parentstringRead-only

Parent entity ID for nested entities.

namestringDefaults to

Entity name within the workspace

projectstring

The name of the project associated with this entity.

default_model_entitystring

autoprovisionedbooleanDefaults to false

Marks this VirtualModel as controller-managed. The Models controller will delete it once no ModelProvider serves the matching entity. Setting this manually opts the VirtualModel into that cleanup behavior.

modelslist of objects

request_middlewarelist of objectsDefaults to []

response_middlewarelist of objectsDefaults to []

post_response_middlewarelist of objectsDefaults to []

override_proxystring

Errors

404

Not Found Error

422

Unprocessable Entity Error