Projects¶
A project is the unit everything else in the AI Suite happens in. Uploaded documents, the context graph built from them, and the questions asked against it all belong to one project. Creating or fetching a project is therefore the first thing you do after constructing a client.
The projects area is the project namespace on the client. Its operations
return a AiProjectHandle, and everything project-scoped
happens on that handle:
sales = client.project.create(project_name="sales", project_type="autograph")
support = client.project.get(project_name="support")
Available operations¶
Operation |
Status |
Page |
|---|---|---|
Create a project |
Available |
|
Get an existing project by name |
Available |
|
List, update or delete a project |
Not yet available |
Arrives in a later release. |
The project handle¶
Create and get return an AiProjectHandle. You never
construct one yourself. A handle is bound to one project and shares the
client’s connection, so any number of handles can live under one client
without signing in again.
The handle exposes the project record as read-only properties:
nameThe project’s name.
project_typeThe project’s type, for example
"autograph".db_nameThe database the project is stored in. This is the client’s
db_name.descriptionThe description, or
Noneif none was given.metadata,files,model_settingsThe project’s later state: registered services, uploaded files and the AutoGraph model configuration. Empty on a freshly created project;
metadataandmodel_settingsare filled once AutoGraph is deployed.projectThe raw
AiProjectrecord, for users who want the platform’s object itself.
The handle also carries the project-scoped areas and one method:
autographThe project’s AutoGraph service: deploy it, ingest the project’s files into the context graph, remove it, read whether it is deployed. One per project. See AutoGraph.
autoragThe project’s retrievers: deploy one, list them, ask a question, remove one. A project can have several. See AutoRAG.
refresh()Reload the project record from the platform and return it. The properties above read from that record, so call
refresh()to see changes made elsewhere, for example a service deployed from another client. Every method onautographandautoragcalls it for you before acting.