AIModels

• constructor( __namedParameters = { [__namedParameters.availableModels], __namedParameters.connector, [__namedParameters.defaultModelId] } )

  module:ai/aicore/model/aimodels~AIModels#constructor

  Parameters

  __namedParameters : object

  Properties

  [ __namedParameters.availableModels ] : string | Array<string>

  __namedParameters.connector : AIConnector

  [ __namedParameters.defaultModelId ] : string

• delegate( events ) → EmitterMixinDelegateChain

  inherited

  module:ai/aicore/model/aimodels~AIModels#delegate

  Delegates selected events to another Emitter. For instance:

  emitterA.delegate( 'eventX' ).to( emitterB );
  emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
  

  Copy code

  then eventX is delegated (fired by) emitterB and emitterC along with data:

  emitterA.fire( 'eventX', data );
  

  Copy code

  and eventY is delegated (fired by) emitterC along with data:

  emitterA.fire( 'eventY', data );
  

  Copy code

  Parameters

  events : Array<string>

  Event names that will be delegated to another emitter.

  Returns

  EmitterMixinDelegateChain

• fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]

  inherited

  module:ai/aicore/model/aimodels~AIModels#fire

  Fires an event, executing all callbacks registered for it.

  The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.

  Type parameters

  TEvent : extends BaseEvent

  The type describing the event. See BaseEvent.

  Parameters

  eventOrInfo : GetNameOrEventInfo<TEvent>

  The name of the event or EventInfo object if event is delegated.

  args : TEvent[ 'args' ]

  Additional arguments to be passed to the callbacks.

  Returns

  GetEventInfo<TEvent>[ 'return' ]

  By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).

• getAll() → Promise<Array<AIModelData>>

  module:ai/aicore/model/aimodels~AIModels#getAll

  Returns a list of available models.

  Returns

  Promise<Array<AIModelData>>

• getAvailableModels() → Promise<Array<AIModelData>>

  module:ai/aicore/model/aimodels~AIModels#getAvailableModels

  Returns a list of available models, which corresponds to all models narrowed down by the availableModels passed to the constructor.

  Note: availableModels may include ids, names, and/or providers.

  Returns

  Promise<Array<AIModelData>>

• getDefault() → Promise<null | AIModelData>

  module:ai/aicore/model/aimodels~AIModels#getDefault

  Returns default AI model among the available models accounting for the defaultModelId passed to the constructor.

  Note: If 'auto' id was specified as defaultModelId in the constructor, it will match the 'agent*' model.

  Returns

  Promise<null | AIModelData>

• getModel( [ modelId ] ) → Promise<null | AIModelData>

  module:ai/aicore/model/aimodels~AIModels#getModel

  Returns a specific AI model from among all models by its id.

  Note: 'auto' id always matches the 'agent*' model.

  Parameters

  [ modelId ] : string

  Returns

  Promise<null | AIModelData>

• isAvailable( model ) → Promise<boolean>

  module:ai/aicore/model/aimodels~AIModels#isAvailable

  Checks whether the given model is available among the available models.

  Parameters

  model : AIModelData

  Returns

  Promise<boolean>

• listenTo( emitter, event, callback, [ options ] ) → void

  inherited

  module:ai/aicore/model/aimodels~AIModels#listenTo:BASE_EMITTER

  Registers a callback function to be executed when an event is fired in a specific (emitter) object.

  Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.

  // myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
  myEmitter.on( 'myGroup', genericCallback );
  myEmitter.on( 'myGroup:myEvent', specificCallback );
  
  // genericCallback is fired.
  myEmitter.fire( 'myGroup' );
  // both genericCallback and specificCallback are fired.
  myEmitter.fire( 'myGroup:myEvent' );
  // genericCallback is fired even though there are no callbacks for "foo".
  myEmitter.fire( 'myGroup:foo' );
  

  Copy code

  An event callback can stop the event and set the return value of the fire method.

  Type parameters

  TEvent : extends BaseEvent

  The type describing the event. See BaseEvent.

  Parameters

  emitter : Emitter

  The object that fires the event.

  event : TEvent[ 'name' ]

  The name of the event.

  callback : GetCallback<TEvent>

  The function to be called on event.

  [ options ] : GetCallbackOptions<TEvent>

  Additional options.

  Returns

  void

• off( event, callback ) → void

  inherited

  module:ai/aicore/model/aimodels~AIModels#off

  Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

  Parameters

  event : string

  The name of the event.

  callback : Function

  The function to stop being called.

  Returns

  void

• on( event, callback, [ options ] ) → void

  inherited

  module:ai/aicore/model/aimodels~AIModels#on

  Registers a callback function to be executed when an event is fired.

  Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).

  Type parameters

  TEvent : extends BaseEvent

  The type descibing the event. See BaseEvent.

  Parameters

  event : TEvent[ 'name' ]

  The name of the event.

  callback : GetCallback<TEvent>

  The function to be called on event.

  [ options ] : GetCallbackOptions<TEvent>

  Additional options.

  Returns

  void

• once( event, callback, [ options ] ) → void

  inherited

  module:ai/aicore/model/aimodels~AIModels#once

  Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.

  Type parameters

  TEvent : extends BaseEvent

  The type descibing the event. See BaseEvent.

  Parameters

  event : TEvent[ 'name' ]

  The name of the event.

  callback : GetCallback<TEvent>

  The function to be called on event.

  [ options ] : GetCallbackOptions<TEvent>

  Additional options.

  Returns

  void

• stopDelegating( [ event ], [ emitter ] ) → void

  inherited

  module:ai/aicore/model/aimodels~AIModels#stopDelegating

  Stops delegating events. It can be used at different levels:

  • To stop delegating all events.
  • To stop delegating a specific event to all emitters.
  • To stop delegating a specific event to a specific emitter.

  Parameters

  [ event ] : string

  The name of the event to stop delegating. If omitted, stops it all delegations.

  [ emitter ] : Emitter

  (requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.

  Returns

  void

• stopListening( [ emitter ], [ event ], [ callback ] ) → void

  inherited

  module:ai/aicore/model/aimodels~AIModels#stopListening:BASE_STOP

  Stops listening for events. It can be used at different levels:

  • To stop listening to a specific callback.
  • To stop listening to a specific event.
  • To stop listening to all events fired by a specific object.
  • To stop listening to all events fired by all objects.

  Parameters

  [ emitter ] : Emitter

  The object to stop listening to. If omitted, stops it for all objects.

  [ event ] : string

  (Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.

  [ callback ] : Function

  (Requires the event) The function to be removed from the call list for the given event.

  Returns

  void

Static methods

• getLocalized( locale, models ) → Array<AIModelData>

  static

  module:ai/aicore/model/aimodels~AIModels.getLocalized

  Translates an arbitrary list of models using the given Locale instance.

  Note:

  • Models with ids starting with "agent" will be named "Auto" (localized) in the user interface and get a localized description.
  • The rest of models known to the translation service keep their original name but still get a localized description.
  • Models unknown to the translation service keep their original name and description.

  Parameters

  locale : Locale

  models : Array<AIModelData>

  Returns

  Array<AIModelData>