Skip to content

Commit

Permalink
fix: align records type with API validation (#163)
Browse files Browse the repository at this point in the history
Signed-off-by: Michele Dolfi <dol@zurich.ibm.com>
  • Loading branch information
dolfim-ibm authored Feb 7, 2024
1 parent 8c45f5d commit 8d0f7be
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions deepsearch/cps/client/components/data_indices.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ def create(
description of data index
type : string, OPTIONAL
type of data index, default is "Document"
possible values: "Document", "DB Records", "Generic", "Experiment"
possible values: "Document", "DB Record", "Generic", "Experiment"
schema_key : string, OPTIONAL
schema of data index, default is "deepsearch_doc"
possible values: "deepsearch-doc", "deepsearch-db", "generic"
Expand All @@ -77,7 +77,7 @@ def create(

if type == "Document":
schema_key = "deepsearch-doc"
elif type == "DB Records":
elif type == "DB Record":
schema_key = "deepsearch-db"
elif type == "Generic":
schema_key = "generic"
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/data_indices.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ In addition, it is possible to specify non-default `type` of data index. For mor
| Type | Description |
| -------------- | ------------------------------------ |
| `Document` | (Default) Index containing documents uploaded as PDF and converted by the platform. |
| `DB Records` | Index containing data matching the DB records schema. This usually orginates from curated data collections, and exposes a schema which can be leveraged in the processing pipeline. |
| `DB Record` | Index containing data matching the DB records schema. This usually orginates from curated data collections, and exposes a schema which can be leveraged in the processing pipeline. |
| `Generic` | Generic type with the least requirements. |
| `Experiment` | Data coming from simulation experiments. |

Expand Down

0 comments on commit 8d0f7be

Please sign in to comment.