This page is automatically generated from the OpenAPI specification.
ModelsApi
All URIs are relative to http://localhost:8000/v1
| Method | HTTP request | Description |
|---|---|---|
| attach_events_to_episode | POST /models/i/{instanceid}/episodes/{episodename}/attach-events | Attach events to an episode |
| attach_metadata_to_event | POST /models/i/{instanceid}/episodes/{episodename}/events/{event_id}/attach-metadata | Attach metadata to an event |
| create_episode | POST /models/i/{instance_id}/create-episode | Create a new episode for a model instance |
| create_model_instance | POST /models/create-instance | Create a new model instance |
| delete_episode | DELETE /models/i/{instanceid}/episodes/{episodename} | Delete an episode for a model |
| delete_model_instance | DELETE /models/i/{instance_id} | Delete a model instance |
| get_available_model | GET /models/available/{model_name} | Get information about a specific model available for creation |
| get_available_models | GET /models/available | Get models available for creation |
| get_episode_info | GET /models/i/{instanceid}/episodes/{episodename} | Get episode information |
| get_episodes | GET /models/i/{instance_id}/episodes | Get all episodes for a model instance |
| get_model_instance | GET /models/i/{instance_id} | Get model instance information |
| get_model_instanceParameters | GET /models/i/{instance_id}/parameters | Get the parameters of a model instance |
| get_model_instanceState | GET /models/i/{instance_id}/state | Get the state of a model instance |
| get_model_instances | GET /models/instances | Get all created model instances |
| run_inference | POST /models/i/{instance_id}/infer | Run inference |
| run_learning | POST /models/i/{instance_id}/learn | Learn from previous observations |
| wipe_episode | POST /models/i/{instanceid}/episodes/{episodename}/wipe | Wipe all events from an episode |
attach_events_to_episode
SuccessResponse attach_events_to_episode(instance_id, episode_name, AttachEventsToEpisodeRequest)
Attach events to an episode
Attach events to a specific episode for a modelParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | UUID | ID of the model instance to attach events to | [default to null] |
| episode_name | String | Name of the episode to attach events to | [default to null] |
| AttachEventsToEpisodeRequest | AttachEventsToEpisodeRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
attach_metadata_to_event
SuccessResponse attach_metadata_to_event(instance_id, episode_name, event_id, AttachMetadataToEventRequest)
Attach metadata to an event
Attach metadata to a specific event for a modelParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | UUID | ID of the model instance to attach metadata to | [default to null] |
| episode_name | String | Name of the episode to attach metadata to | [default to null] |
| event_id | Long | ID of the event to attach metadata to | [default to null] |
| AttachMetadataToEventRequest | AttachMetadataToEventRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
create_episode
EpisodeInfo create_episode(instance_id, CreateEpisodeRequest)
Create a new episode for a model instance
Create a new episode for a specific model instance. Note that the default episode is created automatically when the model instance is created. When a new episode is created, it becomes the current episode for the model instance.Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | UUID | ID of the model instance to create episode for | [default to null] |
| CreateEpisodeRequest | CreateEpisodeRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
create_model_instance
CreateModelInstanceResponse create_model_instance(CreateModelInstanceRequest)
Create a new model instance
Creates a new instance of a model with the specified configurationParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateModelInstanceRequest | CreateModelInstanceRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
delete_episode
SuccessResponse delete_episode(instance_id, episode_name)
Delete an episode for a model
Delete a specific episode for a model instance. Note that the default episode cannot be deleted, but you can wipe data from it. If the deleted episode was the current episode, the default episode will become the current episode.Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | UUID | ID of the model instance to delete episode for | [default to null] |
| episode_name | String | Name of the episode to delete | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
delete_model_instance
SuccessResponse delete_model_instance(instance_id)
Delete a model instance
Delete a specific model instance by its IDParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | UUID | ID of the model instance to delete | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
get_available_model
AvailableModel get_available_model(model_name)
Get information about a specific model available for creation
Retrieve detailed information about a specific model available for creationParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| model_name | String | Name of the model to retrieve information for (including version identifier if applicable, e.g. \"BetaBernoulli-v1\") | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
get_available_models
List get_available_models()
Get models available for creation
Retrieve the list of models available for creation for a given token. This list specifies names and available arguments for each model. **Note** The list of available models might differ for different access tokens. For example, a token with only the \"user\" role might not have access to all models.Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
get_episode_info
EpisodeInfo get_episode_info(instance_id, episode_name)
Get episode information
Retrieve information about a specific episode of a modelParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | UUID | ID of the model instance to retrieve episode for | [default to null] |
| episode_name | String | Name of the episode to retrieve | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
get_episodes
List get_episodes(instance_id)
Get all episodes for a model instance
Retrieve all episodes for a specific model instanceParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | UUID | ID of the model instance to retrieve episodes for | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
get_model_instance
ModelInstance get_model_instance(instance_id)
Get model instance information
Retrieve detailed information about a specific model instanceParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | UUID | ID of the model instance to retrieve information for | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
get_model_instanceParameters
ModelInstanceParameters get_model_instanceParameters(instance_id)
Get the parameters of a model instance
Retrieve the parameters of a specific model instanceParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | UUID | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
get_model_instanceState
ModelInstanceState get_model_instanceState(instance_id)
Get the state of a model instance
Retrieve the state of a specific model instanceParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | UUID | ID of the model instance to retrieve state for | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
get_model_instances
List get_model_instances()
Get all created model instances
Retrieve detailed information about all created model instances for a specific tokenParameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
run_inference
InferResponse run_inference(instance_id, InferRequest)
Run inference
Run inference on a specific model instanceParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | UUID | ID of the model instance to run inference on | [default to null] |
| InferRequest | InferRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
run_learning
LearnResponse run_learning(instance_id, LearnRequest)
Learn from previous observations
Learn from previous episodes for a specific modelParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | UUID | [default to null] | |
| LearnRequest | LearnRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
wipe_episode
SuccessResponse wipe_episode(instance_id, episode_name)
Wipe all events from an episode
Wipe all events from a specific episode for a modelParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_id | UUID | ID of the model instance to wipe episode for | [default to null] |
| episode_name | String | Name of the episode to wipe | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
This page is automatically generated from the OpenAPI specification.