Pre-trained Machine Learning

List all trained models

GET pretrained-ml/trained-models/

Note

Authorized Roles: root, manager, backend

List all the trained instances of your models

Response JSON Object

• warnings (list-of-string) – Optional. List of warnings

• trained_models (list-of-object) –

  Trained models

  Inner fields

  • warnings (list-of-string) – List of warnings

  • id (string) – Trained model id

  • trained_timestamp (int) – Training timestamp

  • algorithm (string) – [Advanced Usage] Algorithm

EXAMPLE RESPONSE

  {
      "trained_models": [
          {
              "id": "102eknfdwd43f",
              "trained_timestamp": 1588812345,
              "algorithm": "implicit-hybrid-cf-user-item-cb:1.2"
          }
      ]
  }

[Internal] List All Retrieval Structures

GET pretrained-ml/retrieval-structures/

Note

Authorized Roles: root, manager, backend

List all the retrieval structures The response is paginated, you can control the response amount and offset using the query parameters amt and page.

Query Parameters

• page (int) – Optional. [min: 1] Page to be listed

• amt (int) – Optional. [min: 1 max: 999] Amount of retrieval structures to return

EXAMPLE QUERY PARAMS

  ?page=1&amt=10

Response JSON Object

• warnings (list-of-string) – Optional. List of warnings

• retrieval_structures (list-of-object) –

  Retrieval structures

  Inner fields

  • warnings (list-of-string) – List of warnings

  • id (string) – Retrieval Structure id

  • trained_timestamp (int) – Training timestamp

  • algorithm (string) – [Advanced Usage] Algorithm

• has_next (bool) – Indicates whether or not there are more pages to request

EXAMPLE RESPONSE

  {
      "retrieval_structures": [
          {
              "id": "102eknfdwd43f",
              "trained_timestamp": 1588812345,
              "algorithm": "implicit-hybrid-cf-user-item-cb:1.2"
          }
      ],
      "has_next": false
  }