Skip to content

docs: add component.md and adjust command.md #20

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: add component.md and adjust command.md #20

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6669f52
docs: add component.md and adjust command.md
Jan 9, 2024
93ca35b
docs: add component.md and adjust command.md
Jan 9, 2024
d62ec86
Merge remote-tracking branch 'upstream/master'
Jan 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 22 additions & 32 deletions docs/tutorial/knext/component.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,50 +58,40 @@ order: 2
**add_property_mapping**
> 添加从非标准数据字段到SPG属性之间的映射关系，并执行绑定到属性所属于的类型schema上的链指策略。

| 参数 | 类型 | 是否必填 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| **source_name** | str | 是 | "useCert" | 源字段 |
| **target_name** | PropertyName | 是 | DEFAULT.App.useCert | SPG属性名 |
| **target_type** | SPGTypeName | 否 | DEFAULT.Cert | SPG属性类型。当前未支持属性多类型，暂不需要填。 |
| **link_strategy** | LinkingStrategy | 否 | CertLinkOp() | 链指策略。当前支持的链指策略：
1、`LinkingStrateEnum.IDEquals`
2、`LinkOp`类型算子
若设置，会在当前任务覆盖schema上绑定的链指策略。 |
| 参数 | 类型 | 是否必填 | 示例值 | 描述 |
| --- | --- | --- | --- |---------------------------------------------------------------|
| **source_name** | str | 是 | "useCert" | 源字段 |
| **target_name** | PropertyName | 是 | DEFAULT.App.useCert | SPG属性名 |
| **target_type** | SPGTypeName | 否 | DEFAULT.Cert | SPG属性类型。当前未支持属性多类型，暂不需要填。 |
| **link_strategy** | LinkingStrategy | 否 | CertLinkOp() | 链指策略，若设置，会在当前任务覆盖schema上绑定的链指策略。当前支持的链指策略：1、`LinkingStrateEnum.IDEquals` 2、`LinkOp`类型算子 |

**add_relation_mapping**
> 添加从非标准数据字段到SPG关系之间的映射关系，并执行绑定到关系所属于的类型schema上的链指策略。

| 参数 | 类型 | 是否必填 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| **source_name** | str | 是 | "belongTo" | 源字段 |
| **target_name** | RelationName | 是 | DEFAULT.App.belongTo | SPG关系名 |
| **target_type** | SPGTypeName | 是 | DEFAULT.Company | SPG关系类型。关系映射上必填。 |
| **link_strategy** | LinkingStrategy | 否 | CertLinkOp() | 链指策略。当前支持的链指策略：
1、`LinkingStrateEnum.IDEquals`
2、`LinkOp`类型算子
若设置，会在当前任务覆盖schema上绑定的链指策略。 |
| 参数 | 类型 | 是否必填 | 示例值 | 描述 |
| --- | --- | --- | --- |---------------------------------------------------------------|
| **source_name** | str | 是 | "belongTo" | 源字段 |
| **target_name** | RelationName | 是 | DEFAULT.App.belongTo | SPG关系名 |
| **target_type** | SPGTypeName | 是 | DEFAULT.Company | SPG关系类型。关系映射上必填。 |
| **link_strategy** | LinkingStrategy | 否 | CertLinkOp() | 链指策略，若设置，会在当前任务覆盖schema上绑定的链指策略。当前支持的链指策略：1、`LinkingStrateEnum.IDEquals` 2、`LinkOp`类型算子 |

**add_predicting_property**
> 添加需要预测的SPG属性字段，并执行绑定到spo三元组上的预测策略。

| 参数 | 类型 | 是否必填 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| **target_name** | PropertyName | 是 | DEFAULT.App.useCert | SPG属性名 |
| **target_type** | SPGTypeName | 否 | DEFAULT.Cert | SPG属性类型。当前未支持属性多类型，暂不需要填。 |
| **predicting_strategy** | PredictingStrategy | 否 | CertPredictOp() | 预测策略。当前支持的预测策略：
1、`PredictOp`类型算子
若设置，会在当前任务覆盖schema上绑定的预测策略。 |
| 参数 | 类型 | 是否必填 | 示例值 | 描述 |
| --- | --- | --- | --- |-----------------------------------|
| **target_name** | PropertyName | 是 | DEFAULT.App.useCert | SPG属性名 |
| **target_type** | SPGTypeName | 否 | DEFAULT.Cert | SPG属性类型。当前未支持属性多类型，暂不需要填。 |
| **predicting_strategy** | PredictingStrategy | 否 | CertPredictOp() | 预测策略，若设置，会在当前任务覆盖schema上绑定的预测策略。当前支持的预测策略：1、`PredictOp`类型算子 |

**add_predicting_relation**
> 添加需要预测的SPG关系字段，并执行绑定到spo三元组上的预测策略。

| 参数 | 类型 | 是否必填 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| **target_name** | RelationName | 是 | DEFAULT.App.belongTo | SPG属性名 |
| **target_type** | SPGTypeName | 是 | DEFAULT.Company | SPG关系类型。关系映射上必填。 |
| **predicting_strategy** | PredictingStrategy | 否 | CertPredictOp() | 预测策略。当前支持的预测策略：
1、`PredictOp`类型算子
若设置，会在当前任务覆盖schema上绑定的预测策略。 |
| 参数 | 类型 | 是否必填 | 示例值 | 描述 |
| --- | --- | --- | --- |------------------------------------|
| **target_name** | RelationName | 是 | DEFAULT.App.belongTo | SPG属性名 |
| **target_type** | SPGTypeName | 是 | DEFAULT.Company | SPG关系类型。关系映射上必填。 |
| **predicting_strategy** | PredictingStrategy | 否 | CertPredictOp() | 预测策略，若设置，会在当前任务覆盖schema上绑定的预测策略。当前支持的预测策略：1、`PredictOp`类型算子。 |

**add_filter**
> 添加字段筛选条件，数据满足`column_name=column_value`条件的会执行映射。若不设置筛选条件，则全部数据会执行映射。
Expand Down