Skip to content

Commit cb48714

Browse files
committed
reference project creation in retriever file; add project name validation rules
1 parent 99c7162 commit cb48714

File tree

4 files changed

+46
-0
lines changed

4 files changed

+46
-0
lines changed

site/content/3.12/data-science/graphrag/services/importer.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ To create a new GraphRAG project, use the `CreateProject` method by sending a
3737
`project_name` and a `project_type` in the request body. Optionally, you can
3838
provide a `project_description`.
3939

40+
The `project_name` must follow these validation rules:
41+
- Length: 1–63 characters
42+
- Allowed characters: letters, numbers, underscores (`_`), and hyphens (`-`)
43+
4044
```curl
4145
curl -X POST "https://<ExternalEndpoint>:8529/gen-ai/v1/project" \
4246
-H "Content-Type: application/json" \
@@ -46,13 +50,23 @@ curl -X POST "https://<ExternalEndpoint>:8529/gen-ai/v1/project" \
4650
"project_description": "A documentation project for GraphRAG."
4751
}'
4852
```
53+
4954
All the relevant ArangoDB collections (such as documents, chunks, entities,
5055
relationships, and communities) created during the import process will
5156
have the project name as a prefix. For example, the Documents collection will
5257
become `<project_name>_Documents`. The Knowledge Graph will also use the project
5358
name as a prefix. If no project name is specified, then all collections
5459
are prefixed with `default_project`, e.g., `default_project_Documents`.
5560

61+
Once created, you can reference your project in other services (such as the
62+
Importer or Retriever) using the `genai_project_name` field:
63+
64+
```json
65+
{
66+
"genai_project_name": "docs"
67+
}
68+
```
69+
5670
### Project metadata
5771

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

site/content/3.12/data-science/graphrag/services/retriever.md

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

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

4453
The Retriever service enables intelligent search and retrieval of information

site/content/3.13/data-science/graphrag/services/importer.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ To create a new GraphRAG project, use the `CreateProject` method by sending a
3737
`project_name` and a `project_type` in the request body. Optionally, you can
3838
provide a `project_description`.
3939

40+
The `project_name` must follow these validation rules:
41+
- Length: 1–63 characters
42+
- Allowed characters: letters, numbers, underscores (`_`), and hyphens (`-`)
43+
4044
```curl
4145
curl -X POST "https://<ExternalEndpoint>:8529/gen-ai/v1/project" \
4246
-H "Content-Type: application/json" \
@@ -46,13 +50,23 @@ curl -X POST "https://<ExternalEndpoint>:8529/gen-ai/v1/project" \
4650
"project_description": "A documentation project for GraphRAG."
4751
}'
4852
```
53+
4954
All the relevant ArangoDB collections (such as documents, chunks, entities,
5055
relationships, and communities) created during the import process will
5156
have the project name as a prefix. For example, the Documents collection will
5257
become `<project_name>_Documents`. The Knowledge Graph will also use the project
5358
name as a prefix. If no project name is specified, then all collections
5459
are prefixed with `default_project`, e.g., `default_project_Documents`.
5560

61+
Once created, you can reference your project in other services (such as the
62+
Importer or Retriever) using the `genai_project_name` field:
63+
64+
```json
65+
{
66+
"genai_project_name": "docs"
67+
}
68+
```
69+
5670
### Project metadata
5771

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

site/content/3.13/data-science/graphrag/services/retriever.md

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

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

4453
The Retriever service enables intelligent search and retrieval of information

0 commit comments

Comments
 (0)