Skip to content

Commit 81d49fb

Browse files
nerpaulaSimran-B
authored andcommitted
reference project creation in retriever file; add project name validation rules
1 parent e48a6d0 commit 81d49fb

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

site/content/ai-suite/reference/importer.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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
3636
provide 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
3943
curl -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+
4752
All the relevant ArangoDB collections (such as documents, chunks, entities,
4853
relationships, and communities) created during the import process will
4954
have the project name as a prefix. For example, the Documents collection will
5055
become `<project_name>_Documents`. The Knowledge Graph will also use the project
5156
name as a prefix. If no project name is specified, then all collections
5257
are 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

5670
Additional project metadata is accessible via the following endpoint, replacing

site/content/ai-suite/reference/retriever.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,15 @@ graph and get contextually relevant responses.
3636
You can also use the GraphRAG Retriever service via the [web interface](../graphrag/web-interface.md).
3737
{{< /tip >}}
3838

39+
## Prerequisites
40+
41+
Before using the Retriever service, you need to create a GraphRAG project and
42+
import data using the Importer service.
43+
44+
For detailed instructions on creating a project, see
45+
[Creating a new project](importer.md#creating-a-new-project) in the Importer
46+
documentation.
47+
3948
## Search methods
4049

4150
The Retriever service enables intelligent search and retrieval of information

0 commit comments

Comments
 (0)