注意:以下翻译的准确性尚未经过验证。这是使用 AIP ↗ 从原始英文文本进行的机器翻译。
外部函数允许您从一个函数调用webhooks,并使用它们与外部系统交互。您可以从使用Workshop、操作和函数构建的应用程序中调用这些系统。
要在函数中使用webhook,您必须首先配置支持webhooks功能的数据连接源。通常这将是一个REST API源。一旦您有了配置了webhooks的源,您可以将该源导入到您的函数库中,并创建调用webhooks和其他逻辑的函数。
您可以将外部函数应用于各种应用案例,包括以下内容:
目前外部函数可能无法直接从TypeScript代码中进行任意API调用,而不首先在数据连接中将请求定义为webhook。
@OntologyEditFunction()
装饰器进行注释。@Query()
装饰器进行注释。在以下设置指南中,我们将逐步创建一个调用免费公共词典API ↗的webhook。如果您已经有一个配置了webhooks的现有源,请继续前往函数中的外部源以从函数中调用webhooks。
此处说明的词典API与Palantir无关,可能随时更改。本教程不构成对生产应用案例使用此API的认可、推荐或建议。
要从函数连接到外部系统,您必须具有一个可以连接到所需外部API的REST API源。您可以按照以下说明配置新的REST API源。
查看概览页面,然后选择右下角的继续。系统将提示您选择连接运行时:直接连接,通过代理或通过代理代理。直接连接是与互联网可访问的任何事物交互时的首选方法,我们将使用它连接到我们的免费词典API。
为您的源选择一个名称,并选择应保存到的项目。
在域部分填写API源的连接信息。我们的免费词典API示例的配置如下所示:
现在,您必须在之前配置的REST API源上设置webhook。在您可以从函数中调用webhook之前,您必须配置webhook并为其指派API名称。一个数据连接源可能有多个与之关联的webhooks。请注意,您的源API名称在命名空间中应是唯一的,并且webhook API名称在源中必须是唯一的。
请按照以下步骤配置一个webhook,以请求词典API来获取单个单词的定义。
wordToDefine
。在我们的示例中,API是一个不修改任何数据的GET请求。因此,我们将保留默认设置Read API
,允许webhook在两种类型的函数中使用:@Query()
和@OntologyEditFunction()
。标记为Write API
的webhooks可能只能在@OntologyEditFunction()
中使用。
一旦保存了webhook,它便可在整个平台上使用。
要开始在函数中使用此源,请继续查看函数中的外部源指南。