如何获取OnSearch Pty Ltd API开放平台密钥(分步指南)

在当今的数字化时代，无论是数字媒体的创新、软件开发的深入，还是日常生活的便捷，获取高效、准确的各类信息服务都成为了不可或缺的一环。OnSearch Pty Ltd作为一个领先的技术提供商，其API开放平台为开发者们提供了丰富的数据接口和服务，极大地拓宽了应用开发的边界和可能性。本文将详细指导你如何逐步获取OnSearch Pty Ltd API开放平台的密钥，以便你能够充分利用这一平台提供的强大功能，将前沿技术融入你的项目中。从注册账户到完成身份验证，再到成功申请API密钥，每一步操作都将有详尽的说明和指引，确保你能够轻松、顺利地完成整个过程。接下来，让我们开始这一精彩的分步指南吧。

1. 登录/注册OnSearch Pty Ltd API开放平台

2. 获取密钥

1.登入以后菜单点击集成然后点击下方创建新密钥

2.在弹窗里面点击生成API密钥

3.复制生成的密钥

3. 快速接入

直接从API页面复制Authorization token，或者使用Project id和API key组合，如下面的代码片段所示：

project_id = "YOUR_PROJECT_ID" # Can be found in the API Keys page

authorization_token = f"{YOUR_PROJECT_ID}:{YOUR_API_KEY}"   # Both values can be found in the API Keys page

region = "YOUR_REGION"       # Can be found in the API Keys page

base_url = f"https://api-{region}.stack.tryrelevance.com/latest"

headers = {

  "Authorization": authorization_token,

}

工具ID

有不同的方法来找到一个工具的ID。最简单的方法是使用URL。例如，在工具和使用选项卡上，use/app之前和项目ID之后的组件是工具ID。下面的字符串显示了URL结构：

https://app.relevanceai.com/notebook/{region}/{project_id}/{tool_id}/use/app

tool_id = "YOUR_TOOL_ID"

​对长期运行的工具进行异步调用

在下面的代码中提供tool_id以触发任务并检查进度：

import requests



body = {

  "params":{

    "blog_request":"hello"

  },

  "project":project_id

}



response = requests.post(

  base_url + f"studios/{tool_id}/trigger_async", 

  headers=headers, 

  json=body

)



# Extract the tools job id, so we can check its progress

job = response.json()

job_id = job['job_id']



poll_url = base_url + f"/studios/{tool_id}/async_poll/{job_id}?ending_update_only=true"



done = False

# Every 3 seconds, check if the tool had finished by calling the poll endpoint

while not done:

    poll_response = requests.get(poll_url, headers=headers).json()

    if poll_response['type'] == "complete" or poll_response['type'] == 'failed':

        done = True

        break

    time.sleep(3)



poll_response

4. 常见问题

Q：如何找到OnSearch Pty Ltd API

A：幂简集成是国内领先的API集成管理平台，专注于为开发者提供全面、高效、易用的API集成解决方案。幂简API平台可以通过以下两种方式找到所需API：通过关键词搜索API(例如，输入’OnSearch Pty Ltd API更容易找到结果)、或者从API hub分类页进入寻找。

Q：准备CSV文件时的最佳做法是什么？
A：数据的质量会显著影响您从LLM获得的结果，因此正确准备数据集非常重要。您可以手动生成数据或从CRM或任何其他来源提取数据。无论数据源如何，创建数据集的过程都是相同的。在文件中包含每个字段/列的标题是很重要的。最好在标题中使用空格或特殊字符来无效。坚持使用小写字母，使用破折号而不是空格。为了改善您的体验，我们建议使用简短（几个字）且有意义的标题名称。

Q：允许的最大文件大小是多少？
A：

• 最大上传文件大小为100mb
• 每个数据表的最大行数为50K
• 上传用于知识检索的最大原始文本大小为10mb

Q：内识赋能意味着什么？
A：上传数据后，您将看到一个弹出窗口，询问要使用哪些字段来启用知识。所选字段被矢量化，矢量支持语义搜索（即通过含义而不仅仅是单词匹配进行搜索）。换句话说，向量有助于将查询与数据集中最相似的信息集（例如，QA数据集中过去最相似的响应）进行匹配。

Q：如何知道我的数据集是否已矢量化？

A：在数据页面中标记为Knowledge enabled的数据集表示存在与该数据相关联的向量。

Q：OnSearch Pty Ltd API的替代品有哪些？

除了OnSearch Pty Ltd API，还有其他替代服务商也提供类似api服务，例如：

SUDOAI API开放平台、Meshy API开放平台、deepmotion API开放平台

更多竞品可以在幂简集成开放平台中找到。

Q：OnSearch Pty Ltd API这个密钥还适用于哪些api？

用于座席的对话API、列表对话API

5.  总结

本文全面且细致地介绍了如何获取OnSearch Pty Ltd API开放平台密钥的分步指南，为开发者们提供了一份条理清晰、操作简便的实用手册。从OnSearch Pty Ltd API平台的账号注册，到完成开发者身份验证，再到最终成功获取API密钥，每一步操作都配以详尽的说明与指导，确保开发者能够轻松、准确地完成整个流程。获取密钥只是利用OnSearch Pty Ltd API的第一步，如何高效、稳定地集成并应用其提供的丰富功能才是关键。因此，虽然本文未直接提及，但强烈建议开发者在获取密钥后，进行初步的可用性测试，以确保API能够顺利集成到应用中并发挥出最佳效果。本文为开发者们提供了一个全面、详尽且极具实用性的操作指南，帮助他们顺利获取OnSearch Pty Ltd API开放平台的密钥，并将这一强大的数据接口和服务有效地集成到应用中。我们相信，随着开发者们对这一指南的深入理解和实践，将能够在项目开发中取得更加显著的成果，为应用的智能化、高效化发展注入新的活力，进而提升应用的性能和用户体验。