Creating a project¶
project = client.project.create(
project_name="my_project",
project_type="autograph",
description="Optional free text.",
)
One call creates the project in the client’s database and returns an
AiProjectHandle bound to it.
Parameters¶
Parameter |
Type |
Meaning |
|---|---|---|
|
|
Name of the project. May contain letters, digits, underscores and hyphens only. |
|
|
Kind of project to create, for example |
|
|
Free-text description. Keyword-only. Omitted entirely when not given. |
The database is not a parameter: the project is created in the db_name the
client was constructed with.
Return value¶
An AiProjectHandle with name, project_type,
db_name and description set from the created project. See
Projects for the property descriptions.
Errors¶
InvalidProjectNameErrorThe name was rejected: it is empty, too long, or contains characters outside letters, digits, underscores and hyphens.
Any other failure surfaces as one of the general SDK exceptions described in
Errors, for example
PlatformUnreachableError if the deployment
could not be reached, or ServiceError
carrying the status code and message the service returned.
Example¶
from arango_ai_sdk.exceptions import InvalidProjectNameError
try:
project = client.project.create(
project_name="my project", # a space is not allowed
project_type="autograph",
)
except InvalidProjectNameError as exc:
print(f"Choose another name: {exc}")
else:
print(f"Created {project.name} in {project.db_name}")