Projects.AI.Providers Entity

Namespace: Projects.AI

Specifies provider and base model, on which the user models can be based. Entity: Llm_Providers (Introduced in version 24.1.3.3)

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Name
Name Data Member:
Name
Category: Settings
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Projects.AI.Providers

Attributes

Name	Type	Description
BaseModelName	string (64)	Provider-specific base model (for example "gpt-3.5-turbo-0613"), to which we will add domain specific knowledge. `Required` `Filter(eq)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
Name	MultilanguageString (256)	Multi-language name of the provider. `Required` `Filter(like)`
Notes	string (max) nullable	Notes for this Provider.
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
ProviderApiKey	string (128)	The API key (provided by the model provider), which should be used to access the provider API. `Required`
ProviderField	ProviderField	The provider of the base model. Currently, only OpenAI is supported. `Required` `Default("OpenAI")` `Filter(eq)`

Attribute Details

BaseModelName

Provider-specific base model (for example "gpt-3.5-turbo-0613"), to which we will add domain specific knowledge. Required Filter(eq)

Type: string (64)
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

Name

Multi-language name of the provider. Required Filter(like)

Type: MultilanguageString (256)
Category: System
Supported Filters: Like
Supports Order By: False
Show in UI: ShownByDefault

Notes

Notes for this Provider.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

ProviderApiKey

The API key (provided by the model provider), which should be used to access the provider API. Required

Type: string (128)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 128
Show in UI: ShownByDefault

ProviderField

The provider of the base model. Currently, only OpenAI is supported. Required Default("OpenAI") Filter(eq)

Type: ProviderField
Category: System
Allowed values for the ProviderField(Projects.AI.Providers.md#providerfield) data attribute
Allowed Values (Projects.AI.ProvidersRepository.ProviderField Enum Members)

Value	Description
OpenAI	OpenAI value. Stored as 'OpenAI'. Database Value: 'OpenAI' Model Value: 0 Domain API Value: 'OpenAI'

Supported Filters: Equals
Supports Order By: False
Default Value: OpenAI
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST