Ontology 更改

除了编写从 Ontology 读取数据的函数外，您还可以编写创建对象并编辑对象之间属性和链接的函数。 本页记录了函数中可用的对象编辑 API。 有关编辑函数如何工作的更多详细信息，请参阅概述页面。

为了使函数中创建的更改实际应用，Ontology 编辑函数必须配置为函数支持的操作。 以这种方式配置操作可以让您提供附加元数据、配置权限，并在各种操作接口中访问操作。 正如文档中所指出的那样，在操作之外运行编辑函数实际上不会修改任何对象数据。

定义编辑函数

编辑 Ontology 的函数必须：

• 使用从 functions.api 导入的 @function(edits=[MyObjectType]) 装饰器来指定将要编辑的对象类型。
• 具有从 functions.api 导入的显式 Array[OntologyEdit] 返回类型提示。

构建 Ontology 编辑容器

要在 Python 函数中执行 Ontology 编辑，首先从 OSDK 客户端构建一个 Ontology 编辑容器。例如：

Copied!
1
2
3
4
5
ontology_edits = FoundryClient().ontology.edits()
# 创建一个FoundryClient实例，并通过它获取ontology的edits
# FoundryClient是一个用于连接Foundry平台的客户端库
# ontology是指本体，用于定义概念及其关系
# edits可能是指对本体的编辑或修改操作

这个容器用于跟踪在函数中所做的所有编辑。

更新属性

在Python函数中的Ontology对象默认是只读的。尝试修改其属性将引发异常。

为了编辑一个对象，首先需要使用Ontology编辑容器获取该对象的可编辑视图，可以从现有对象实例获取：

Copied!
1
2
# 调用 `MyObjectType` 类中的 `edit` 方法来编辑 `my_object` 对象
editable_object = edits.objects.MyObjectType.edit(my_object)

或给定一个Object主键：

Copied!
1
2
# 使用 MyObjectType 的 edit 方法编辑对象
editable_object = edits.objects.MyObjectType.edit(object_primary_key)

一旦您有一个可编辑的Object，您可以通过重新指派Object的属性值来编辑属性值。例如：

Copied!
1
2
# 将可编辑的员工对象的姓氏更新为新名称
editable_employee.last_name = new_name

在同一函数执行过程中，随后访问editable_employee的last_name属性值将返回刚刚设置的新值。然而，原始的不可编辑Object将不会反映这些更改。

可编辑Object上的数组属性是只读的。要修改数组，请创建其副本，修改副本，然后更新属性：

Copied!
1
2
3
4
5
6
# 复制到一个新的数组
array_copy = list(editable_object.my_array_property)
# 现在你可以修改复制的数组
array_copy.append(new_item)
# 然后覆盖属性的值
editable_object.my_array_property = array_copy

请注意，现有Object的主键属性值无法更新。

更新链接

单链接和多链接属性有多种方法可以用于更新链接：

Copied!
1
2
3
4
5
6
7
8
9
10
11
# 设置员工的主管
editable_employee.supervisor.set(new_supervisor)

# 清除员工的主管
editable_employee.supervisor.clear()

# 给指定员工添加新的报告
editable_employee.reports.add(new_report)

# 删除与指定员工关联的旧报告
editable_employee.reports.remove(new_report)

与更新属性一样，在更新后访问 editable_employee 的链接将反映您所做的更新。

创建Objects

您可以使用Ontology编辑容器上的 MyObjectType.create() 方法创建新的Objects。创建新的Object时，必须为其主键指定一个值。

在此示例中，我们创建一个具有给定ID的新Ticket Object，设置其 due_date 属性，并通过修改 assigned_tickets 链接将其指派给给定的Employee。

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from datetime import datetime, timedelta

from functions.api import function, Integer, Array, OntologyEdit
from ontology_sdk import FoundryClient
from ontology_sdk.ontology.objects import Employee, Ticket

@function(edits=[Employee, Ticket])
def create_new_ticket_and_assign_to_employee(employee: Employee, ticket_id: Integer) -> list[OntologyEdit]:
    # 创建本体编辑客户端实例
    ontology_edits = FoundryClient().ontology.edits()

    # 创建新的工单对象，并设置其ID
    new_ticket = ontology_edits.objects.Ticket.create(ticket_id)
    # 设置工单的截止日期为当前日期加上7天
    new_ticket.due_date = datetime.now() + timedelta(days=7)

    # 获取可编辑的员工对象
    editable_employee = ontology_edits.objects.Employee.edit(employee)
    # 将新创建的工单添加到员工的已分配工单中
    editable_employee.assigned_tickets.add(new_ticket)

    # 返回所有的编辑操作
    return ontology_edits.get_edits()

此代码定义了一个函数 create_new_ticket_and_assign_to_employee，用于创建一个新的工单并将其分配给指定的员工。通过使用 FoundryClient 创建和编辑本体对象，函数将新工单添加到员工的已分配工单列表中，并返回所有的编辑操作。 属性值也可以直接传递给创建方法，除了主键。例如：

Copied!
1
2
3
new_due_date = datetime.now() + timedelta(days=7)
# 创建一个新的工单，并设置其到期日期为当前日期加7天
new_ticket = ontology_edits.objects.Ticket.create(ticket_id, due_date=new_due_date)

删除Objects

您可以通过在Ontology编辑容器上调用MyObjectType.delete()方法来删除一个Object。

在此示例中，我们删除指派给指定员工的所有票据：

Copied!
1
2
3
for ticket in employee.tickets:
    # 遍历员工的票据列表，并删除每个票据
    ontology_edits.objects.Ticket.delete(ticket)

可以使用主键而不是实例来删除Objects：

Copied!
1
2
# 删除指定 ID 的 Ticket 对象
ontology_edits.objects.Ticket.delete(ticket_id)