AI Apps
An AI app is the workspace that groups all evaluation runs for a given AI use case, their results and artefacts and the tooling to govern the AI app, such as policies and risk policies.
# app.yaml
key: "airline-assistant"
display_name: "Airline Virtual Assistant"
description: "Customer-facing assistant for flight bookings and changes."
key_info:
lifecycle_stage: "production"
user_types: "external"
data_classification: "confidential"Describing the use case
Beyond identity and descriptions, an app records the deployment context of the use case in key_info. These fields document the app rather than affecting how it is evaluated:
| Field | Values |
|---|---|
lifecycle_stage |
ideation, r_and_d, development, testing, production, retired |
user_types |
internal_specialist, internal_all, external |
data_classification |
public, internal, confidential, restricted |
has_pii_access, has_client_data_access |
true, false |
built_by |
in_house, third_party |
long_description accepts Markdown, so a full use-case description can be kept in a separate file and pulled in with long_description: !include "./README.md".
Working with AI apps
Scaffold a project in the current directory with lf init, then register the app with lf add app. lf switch selects the active app - much like checking out a Git branch, every later command applies to that app until you switch again. Use lf list app to see the available apps, lf export app to write an app’s definition back to YAML, and lf delete app to remove an app with all of its entities. See the AI apps guide for a walkthrough.
Configuration
Properties
key string required
Unique identifier assigned to the entity in AI Platform.
Pattern: ^[a-zA-Z0-9_\-]+$
Max Length: 250
display_name string required
The AI app’s name displayed to the user.
description string
Short text description of the AI app.
Default: None
long_description string
Long description of the AI app. Supports Markdown formatting.
Default: None
key_info AIAppKeyInformation
Key information for the AI app.
Default: None
tags array[string]
Tags associated with the AI app.
Default: []
model_under_test_key string
Key of an existing model to be used as a model under test for this AI app.
Default: None
judge_model_key string
Key of an existing model to be used as a judge model for this AI app.
Default: None
AI App (Simple)
display_name: "My App"
key: "my-app"AI App (Advanced)
display_name: "Full AI App"
key: "full-ai-app"
tags: ["Guides", "AI App"]
description: "LatticeFlow AI Airlines Virtual Assistant"
long_description: !include "./README.md"
key_info:
lifecycle_stage: "production"
user_types: "external"
data_classification: "confidential"
has_pii_access: true
has_client_data_access: true
built_by: "in_house"