@ohos.data.intelligence (智慧数据平台)

智慧数据平台（ArkData Intelligence Platform，AIP）提供端侧的数据智慧化能力，完成数据和AI智能在端侧闭环。作为端侧智慧化能力底座，将构建以下能力： - 多模态嵌入模型：使用嵌入模型（Embedding Model）对多模态数据生成向量表征，将文本、图片等数据映射到同一向量空间，支撑基于语义的多模态知识检索。 - 多模态数据存储：支持端侧向量、倒排索引等多模态数据存储，避免将原始数据发送到服务器进行处理，减少了数据泄露的风险。 - 知识检索：逐步构建语义索引、知识图谱、召回、重排等能力，支持用户知识的语义化检索。 - 知识生成与整理：基于用户文档、消息、电子邮件、照片、视频、日历事件、屏幕上下文等数据，支持高效数据整理与知识生成，实现数据到知识的转换。

说明：

本模块首批接口从API version 15开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

考虑到数据向量化处理的计算量和资源占用较大，当前仅支持在2in1设备上使用。

导入模块

import { intelligence } from '@kit.ArkData';

intelligence.getTextEmbeddingModel

getTextEmbeddingModel(config: ModelConfig): Promise<TextEmbedding>

获取文本嵌入模型，使用Promise异步回调。

系统能力： SystemCapability.DistributedDataManager.DataIntelligence.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和智慧数据平台错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let textConfig:intelligence.ModelConfig = {
  version:intelligence.ModelVersion.BASIC_MODEL,
  isNpuAvailable:false,
  cachePath:"/data"
}
let textEmbedding:intelligence.TextEmbedding;

intelligence.getTextEmbeddingModel(textConfig)
  .then((data:intelligence.TextEmbedding) => {
    console.info("Succeeded in getting TextModel");
    textEmbedding = data;
  })
  .catch((err:BusinessError) => {
    console.error("Failed to get TextModel and code is " + err.code);
  })

intelligence.getImageEmbeddingModel

getImageEmbeddingModel(config: ModelConfig): Promise<ImageEmbedding>

获取图像嵌入模型。使用Promise异步回调。

系统能力： SystemCapability.DistributedDataManager.DataIntelligence.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和智慧数据平台错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let imageConfig:intelligence.ModelConfig = {
    version:intelligence.ModelVersion.BASIC_MODEL,
    isNpuAvailable:false,
    cachePath:"/data"
}
let imageEmbedding:intelligence.ImageEmbedding;

intelligence.getImageEmbeddingModel(imageConfig)
  .then((data:intelligence.ImageEmbedding) => {
    console.info("Succeeded in getting ImageModel");
    imageEmbedding = data;
  })
  .catch((err:BusinessError) => {
    console.error("Failed to get ImageModel and code is " + err.code);
  })

intelligence.splitText

splitText(text: string, config: SplitConfig): Promise<Array<string>>

获取文本的分块。

系统能力： SystemCapability.DistributedDataManager.DataIntelligence.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和智慧数据平台错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let splitConfig:intelligence.SplitConfig = {
  size:10,
  overlapRatio:0.1
}
let splitText = 'text';

intelligence.splitText(splitText, splitConfig)
  .then((data:Array<string>) => {
    console.info("Succeeded in splitting Text");
  })
  .catch((err:BusinessError) => {
    console.error("Failed to split Text and code is " + err.code);
  })

ModelConfig

管理嵌入模型的配置信息。

系统能力： SystemCapability.DistributedDataManager.DataIntelligence.Core

ModelVersion

模型版本枚举。

系统能力： SystemCapability.DistributedDataManager.DataIntelligence.Core

Image

type Image = string

表示图片的URI地址，对应为string类型。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

SplitConfig

管理文本分块的配置信息。

系统能力： SystemCapability.DistributedDataManager.DataIntelligence.Core

TextEmbedding

描述多模态嵌入模型的文本嵌入函数。

下列接口都需先使用intelligence.getTextEmbeddingModel获取到TextEmbedding实例，再通过此实例调用对应接口。

系统能力： SystemCapability.DistributedDataManager.DataIntelligence.Core

loadModel

loadModel(): Promise<void>

加载嵌入模型，使用Promise异步回调。

系统能力： SystemCapability.DistributedDataManager.DataIntelligence.Core

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和智慧数据平台错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

textEmbedding.loadModel()
  .then(() => {
    console.info("Succeeded in loading Model");
  })
  .catch((err:BusinessError) => {
    console.error("Failed to load Model and code is " + err.code);
  })

releaseModel

releaseModel(): Promise<void>

释放嵌入模型，使用Promise异步回调。

系统能力： SystemCapability.DistributedDataManager.DataIntelligence.Core

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和智慧数据平台错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

textEmbedding.releaseModel()
  .then(() => {
    console.info("Succeeded in releasing Model");
  })
  .catch((err:BusinessError) => {
    console.error("Failed to release Model and code is " + err.code);
  })

getEmbedding

getEmbedding(text: string): Promise<Array<number>>

获取给定文本的嵌入向量。

该接口需先调用loadModel加载嵌入模型，加载成功后调用getEmbedding。

系统能力： SystemCapability.DistributedDataManager.DataIntelligence.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和智慧数据平台错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';


textEmbedding.loadModel();
let text = 'text';
textEmbedding.getEmbedding(text)
  .then((data:Array<number>) => {
    console.info("Succeeded in getting Embedding");
  })
  .catch((err:BusinessError) => {
    console.error("Failed to get Embedding and code is " + err.code);
  })

getEmbedding

getEmbedding(batchTexts: Array<string>): Promise<Array<Array<number>>>

获取给定批次文本的嵌入向量。

该接口需先调用loadModel加载嵌入模型，加载成功后调用getEmbedding。

系统能力： SystemCapability.DistributedDataManager.DataIntelligence.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和智慧数据平台错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';


textEmbedding.loadModel();
let batchTexts = ['text1','text2'];
textEmbedding.getEmbedding(batchTexts)
  .then((data:Array<Array<number>>) => {
    console.info("Succeeded in getting Embedding");
  })
  .catch((err:BusinessError) => {
    console.error("Failed to get Embedding and code is " + err.code);
  })

ImageEmbedding

描述多模态嵌入模型的图像嵌入函数。

下列接口都需先使用intelligence.getImageEmbeddingModel获取到ImageEmbedding实例，再通过此实例调用对应接口。

系统能力： SystemCapability.DistributedDataManager.DataIntelligence.Core

loadModel

loadModel(): Promise<void>

加载嵌入模型，使用Promise异步回调。

系统能力： SystemCapability.DistributedDataManager.DataIntelligence.Core

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和智慧数据平台错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

imageEmbedding.loadModel()
  .then(() => {
    console.info("Succeeded in loading Model");
  })
  .catch((err:BusinessError) => {
    console.error("Failed to load Model and code is " + err.code);
  })

releaseModel

releaseModel(): Promise<void>

释放嵌入模型，使用Promise异步回调。

系统能力： SystemCapability.DistributedDataManager.DataIntelligence.Core

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和智慧数据平台错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

imageEmbedding.releaseModel()
  .then(() => {
    console.info("Succeeded in releasing Model");
  })
  .catch((err:BusinessError) => {
    console.error("Failed to release Model and code is " + err.code);
  })

getEmbedding

getEmbedding(image: Image): Promise<Array<number>>

获取给定图像的嵌入向量。

该接口需先调用loadModel加载嵌入模型，加载成功后调用getEmbedding。

系统能力： SystemCapability.DistributedDataManager.DataIntelligence.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和智慧数据平台错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

imageEmbedding.loadModel();
let image = 'file://<packageName>/data/storage/el2/base/haps/entry/files/xxx.jpg';
imageEmbedding.getEmbedding(image)
  .then((data:Array<number>) => {
    console.info("Succeeded in getting Embedding");
  })
  .catch((err:BusinessError) => {
    console.error("Failed to get Embedding and code is " + err.code);
  })

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkData（方舟数据管理）

harmony 鸿蒙Class (RdbPredicates)

harmony 鸿蒙arkts-apis-data-relationalStore-RdbStore

harmony 鸿蒙Interface (ResultSet)

harmony 鸿蒙Interface (Transaction)

harmony 鸿蒙Enums

harmony 鸿蒙Functions

harmony 鸿蒙Interfaces (其他)

harmony 鸿蒙Types

harmony 鸿蒙模块描述