About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class AiService

Provides access to AI model services for chat completion.

Since

2.5

Hierarchy (View Summary)

Spotfire.Object
- AiService

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Extended capability 'AI'

HasModels GetDefaultModel GetModel

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): T1 | null
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1 | null
Inherited from Object.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from Object.Equals

Extended capability 'AI'

HasModels

get HasModels(): boolean
Gets a value indicating whether any Spotfire.Dxp.Framework.Ai.AiModel is available.

Returns boolean
Since
2.5

GetDefaultModel

GetDefaultModel(): Spotfire.Dxp.Framework.Ai.AiModel
Get the default model for the service.

Returns Spotfire.Dxp.Framework.Ai.AiModel
The default AI model configured for this service.

Since
2.5

GetModel

GetModel(
tag: string | System.String,
...additionalTags: (string | System.String)[],
): Spotfire.Dxp.Framework.Ai.AiModel | null
Gets the first configured model tagged with all of the given tags (compared case-insensitively), in configured order, or null when no model matches.
Parameters
- tag: string | System.String
  A required tag; at least one tag must be supplied. See Spotfire.Dxp.Framework.Ai.AiModelTag for the well-known tags.
- ...additionalTags: (string | System.String)[]
  Further tags that a matching model must also carry.
Returns Spotfire.Dxp.Framework.Ai.AiModel | null
The first model carrying every given tag, or null when none match.

Remark
This forms a First/FirstOrDefault pair with Spotfire.Dxp.Framework.Ai.AiService.GetDefaultModel: it returns null on a miss so the caller can fall back or proceed without AI, whereas Spotfire.Dxp.Framework.Ai.AiService.GetDefaultModel throws when nothing is configured. Combine with Spotfire.Dxp.Framework.Ai.AiService.HasModels to tell an unconfigured service apart from a configured one where no model matched the requested tags.

Since
2.6