Quickstart¶
Take the shortest path to load a dataset, create a processing pipeline, and verify that the results are searchable.
Use cases¶
A workspace is the primary boundary for resources, members, and permissions.
AI Studio entries vary with account permissions, deployment mode, and feature flags.
We recommend starting with the shortest path: connect data, process it, build a knowledge base, and then use an agent.
Prerequisites¶
Sign in with the intended account and switch to the target workspace.
Confirm that the account can view the target resources and perform the required actions.
For external systems, prepare network access, a least-privilege account, and valid credentials.
Product entry and core objects¶
Item |
Current implementation |
|---|---|
Page entry |
Workspace home at |
Service contract |
|
Core objects |
Account session, Workspace, Effective roles, Feature flags, Product entries |
Procedure¶
Create or select a workspace.
Create a source under Data Connections and test the connection.
Create an ingestion task to write the data to a Catalog target.
Create a workflow or knowledge base and bind it to the ingested data.
Run a task once and verify the output in the execution records or conversation results.
State model¶
State or signal |
Interpretation and action |
|---|---|
Signed in / signed out |
Determines whether the account or workspace surface is shown. |
Workspace selected |
Scopes resource lists, authorization, and downstream routes. |
Entry visible / hidden |
Depends on authorization, deployed products, and runtime feature flags. |
Result validation¶
The page shows a successful state with the expected object name, workspace, and update time.
The result persists after refresh, and downstream operations can read the latest configuration.
On failure, retain the error and request ID, then check permissions, networking, credentials, and dependency state.
Troubleshooting¶
Symptom |
Recommended action |
|---|---|
Redirect loop after sign-in |
Check the account URL, callback URI, cookies, and system clock. |
No workspace is available |
Confirm workspace membership and effective-role synchronization. |
A menu entry is missing |
Check feature flags first, then resource authorization and deployed version. |
Production readiness¶
Identity and authorization: use a least-privilege account in the target workspace and verify read, write, run, and delete separately.
Change and rollback: record object IDs, versions, execution IDs, and timestamps; prepare rollback for delete, overwrite, and reindex operations.
Capacity and reliability: validate timeouts, concurrency, quotas, retries, and downstream impact on a representative small batch first.
Observability: correlate UI state with service logs, task timelines, or operation logs instead of relying on a single success toast.