@@ -35,6 +35,10 @@ To create a new GraphRAG project, use the `CreateProject` method by sending a
3535` project_name ` and a ` project_type ` in the request body. Optionally, you can
3636provide a ` project_description ` .
3737
38+ The ` project_name ` must follow these validation rules:
39+ - Length: 1–63 characters
40+ - Allowed characters: letters, numbers, underscores (` _ ` ), and hyphens (` - ` )
41+
3842``` curl
3943curl -X POST "https://<ExternalEndpoint>:8529/ai/v1/project" \
4044-H "Content-Type: application/json" \
@@ -44,13 +48,23 @@ curl -X POST "https://<ExternalEndpoint>:8529/ai/v1/project" \
4448 "project_description": "A documentation project for GraphRAG."
4549}'
4650```
51+
4752All the relevant ArangoDB collections (such as documents, chunks, entities,
4853relationships, and communities) created during the import process will
4954have the project name as a prefix. For example, the Documents collection will
5055become ` <project_name>_Documents ` . The Knowledge Graph will also use the project
5156name as a prefix. If no project name is specified, then all collections
5257are prefixed with ` default_project ` , e.g., ` default_project_Documents ` .
5358
59+ Once created, you can reference your project in other services (such as the
60+ Importer or Retriever) using the ` genai_project_name ` field:
61+
62+ ``` json
63+ {
64+ "genai_project_name" : " docs"
65+ }
66+ ```
67+
5468### Project metadata
5569
5670Additional project metadata is accessible via the following endpoint, replacing
0 commit comments