GeneXus Cognitive API - Check procedure

Checks the training state of a custom model.

Parameters

• in:&model :: Model, GeneXusAI.Custom
  The model information to be checked.

• in:&provider :: Provider, GeneXusAI.Configuration
  Provider settings.

• inout:&Messages :: Messages, GeneXus.Common
  A collection of warning and error messages returned by the task. You should check in your code if an error was returned. Refer to error codes and descriptions for more information.

• out:&State :: State, GeneXusAI.Custom
  The training state (training, ready, aborted or unknown).

Configuration

The following table resumes the configuration properties (access credentials) you must set in order to use this AI task.

Sample

After triggering the GeneXus Cognitive API - Train procedure, for example, you can check the training status as follows:

do while True
   &ret = Sleep(60) // wait 60 sec until re-poll
   &State = GeneXusAI.Custom.Check(&model, &provider, &Messages)
   if &State <> GeneXusAI.Custom.State.Training OR &Messages.Count > 0
      exit // break the loop if it is ready, had aborted or raises an error
   endIf
endDo

Notes

• Calling this task makes sense after you call the GeneXus Cognitive API - Train procedure.
• Despite that the &State return variable belongs to State domain, it could adopt another string value if the provider you are using introduces a new state.

Scope

Availability

This procedure is available as of GeneXus 16 upgrade 6.

• As of GeneXus 16 upgrade 8
  -  Google Auto ML is available.

See also

• GeneXus Cognitive API - Train procedure
• HowTo: Build a custom model for GeneXus Cognitive API