Skip to content

Latest commit

 

History

History
294 lines (212 loc) · 9.86 KB

Projects.AI.ModelQAs.md

File metadata and controls

294 lines (212 loc) · 9.86 KB
Raw
uid
Projects.AI.ModelQAs

Projects.AI.ModelQAs Entity

Namespace: Projects.AI

Questions and desired answers, forming the actual knowledge base of the model. Entity: Llm_Model_QAs (Introduced in version 24.1.1.93)

Default Visualization

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

Aggregate

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

Aggregate Parent:
Projects.AI.Models
Aggregate Root:
Projects.AI.Models

Attributes

Name Type Description
Answer string (max) Desired answer. Required Filter(like)
CreationTimeUtc datetime The time when the QA was created. Required Default(NowUtc) Filter(eq;ge;le) ReadOnly
DeactivatonTimeUtc datetime nullable The time when the QA was deactivated. Filter(eq;ge;le) ReadOnly
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
IsActive boolean Indicates whether to include this QA in future builds. Required Default(true) Filter(eq)
Notes string (max) nullable Notes for this ModelQA.
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.
QAType QAType Specifies whether the QA is training or validation. Validation QAs are used to test the correctness of the model and are only reported in the build logs. Required Default("T") Filter(eq)
Question string (max) User question. Required Filter(like)
Section string (128) Free text organizational section of the QA. Required

References

Name Type Description
AddedByUser Users The user which added the QA. Required Filter(multi eq) ReadOnly
Model Models The model to which the question belongs. Required Filter(multi eq) Owner

Attribute Details

Answer

Desired answer. Required Filter(like)

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

CreationTimeUtc

The time when the QA was created. Required Default(NowUtc) Filter(eq;ge;le) ReadOnly

Type: datetime
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTimeUtc
Show in UI: ShownByDefault

DeactivatonTimeUtc

The time when the QA was deactivated. Filter(eq;ge;le) ReadOnly

Type: datetime nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
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

IsActive

Indicates whether to include this QA in future builds. Required Default(true) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

Notes

Notes for this ModelQA.

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

QAType

Specifies whether the QA is training or validation. Validation QAs are used to test the correctness of the model and are only reported in the build logs. Required Default("T") Filter(eq)

Type: QAType
Category: System
Allowed values for the QAType(Projects.AI.ModelQAs.md#qatype) data attribute
Allowed Values (Projects.AI.ModelQAsRepository.QAType Enum Members)

Value Description
Training Training value. Stored as 'T'.
Database Value: 'T'
Model Value: 0
Domain API Value: 'Training'
Validation Validation value. Stored as 'V'.
Database Value: 'V'
Model Value: 1
Domain API Value: 'Validation'

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

Question

User question. Required Filter(like)

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

Section

Free text organizational section of the QA. Required

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

Reference Details

AddedByUser

The user which added the QA. Required Filter(multi eq) ReadOnly

Type: Users
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Model

The model to which the question belongs. Required Filter(multi eq) Owner

Type: Models
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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

Creates a notification and sends a real time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The subject.
    Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

[!list limit=1000 erp.entity=Projects.AI.ModelQAs erp.type=business-rule default-text="None"]

Front-End Business Rules

[!list limit=1000 erp.entity=Projects.AI.ModelQAs erp.type=front-end-business-rule default-text="None"]

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Projects_AI_ModelQAs?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Projects_AI_ModelQAs?$top=10