# CANN

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

## 概述

> phone | 2in1 | tablet | tv

提供CANN Kit模型推理的相关接口。

提供用于LLM模型推理的API。

**系统能力：** SystemCapability.AI.HiAIFoundation

**起始版本：** 4.1.0(11)
> 说明
>
> CANN Kit的模型编译、加载、推理等基础功能接口已抽取放在[neural_network_core.h](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-core-h)中，此处重点描述高阶功能。

## 汇总

> phone | 2in1 | tablet | tv

### 文件

> phone | 2in1 | tablet | tv

|名称|描述|
|:----------------------------------------------------------------------------------------------------------------|:---------------------------------------------|
|[hiai_aipp_param.h](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-hiai-aipp-param-8h)|模型推理时动态AIPP对象创建，参数设置和查询的接口。|
|[hiai_helper.h](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-hiai-helper-8h)|查询CANN Kit版本以及检查模型支持情况的接口。|
|[hiai_options.h](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-hiai-options-8h)|选项参数的接口。|
|[hiai_single_op.h](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-hiai-single-op-8h)|定义CANN Kit单算子接口，用于单算子的创建、计算以及Tensor和Buffer的管理。|
|[hiai_tensor.h](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-hiai-tensor-8h)|模型推理时使用的输入输出内存相关的辅助接口。|
|[llm_engine.h](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-llm-engine)|定义用于LLM模型推理的API。|

### 结构体

> phone | 2in1 | tablet | tv

|名称|描述|
|:------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------|
|struct [HiAISingleOpDescriptor_ConvolutionParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopdesc-convparam)|[HMS_HiAISingleOpDescriptor_CreateConvolution](#hms_hiaisingleopdescriptor_createconvolution)输入参数。|
|struct [HiAI_SingleOpExecutorConvolutionParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopexec-convparam)|[HMS_HiAISingleOpExecutor_CreateConvolution](#hms_hiaisingleopexecutor_createconvolution)输入参数。|
|struct [HiAI_SingleOpExecutorFusedConvolutionActivationParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopexec-fusedconv-actparam)|[HMS_HiAISingleOpExecutor_CreateFusedConvolutionActivation](#hms_hiaisingleopexecutor_createfusedconvolutionactivation)输入参数。|

### 类型定义

> phone | 2in1 | tablet | tv

|名称|描述|
|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------|
|typedef struct [HiAI_AippParam](#hiai_aippparam) [HiAI_AippParam](#hiai_aippparam)|AIPP参数对象。|
|typedef struct [HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc) [HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)|单算子Tensor描述的句柄。|
|typedef struct [HiAI_SingleOpBuffer](#hiai_singleopbuffer) [HiAI_SingleOpBuffer](#hiai_singleopbuffer)|单算子Buffer句柄。|
|typedef struct [HiAI_SingleOpTensor](#hiai_singleoptensor) [HiAI_SingleOpTensor](#hiai_singleoptensor)|单算子Tensor句柄。|
|typedef struct [HiAI_SingleOpOptions](#hiai_singleopoptions) [HiAI_SingleOpOptions](#hiai_singleopoptions)|单算子选项句柄。|
|typedef struct [HiAI_SingleOpDescriptor](#hiai_singleopdescriptor) [HiAI_SingleOpDescriptor](#hiai_singleopdescriptor)|单算子的算子描述句柄。|
|typedef struct [HiAISingleOpDescriptor_ConvolutionParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopdesc-convparam) [HiAISingleOpDescriptor_ConvolutionParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopdesc-convparam)|[HMS_HiAISingleOpDescriptor_CreateConvolution](#hms_hiaisingleopdescriptor_createconvolution)输入参数。|
|typedef struct [HiAI_SingleOpExecutorConvolutionParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopexec-convparam) [HiAI_SingleOpExecutorConvolutionParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopexec-convparam)|[HMS_HiAISingleOpExecutor_CreateConvolution](#hms_hiaisingleopexecutor_createconvolution)输入参数。|
|typedef struct [HiAI_SingleOpExecutorFusedConvolutionActivationParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopexec-fusedconv-actparam) [HiAI_SingleOpExecutorFusedConvolutionActivationParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopexec-fusedconv-actparam)|[HMS_HiAISingleOpExecutor_CreateFusedConvolutionActivation](#hms_hiaisingleopexecutor_createfusedconvolutionactivation)输入参数。|
|typedef struct [HiAI_SingleOpExecutor](#hiai_singleopexecutor) [HiAI_SingleOpExecutor](#hiai_singleopexecutor)|单算子执行器句柄。|
|typedef struct [HMS_LLMEngine_Context](#hms_llmengine_context) [HMS_LLMEngine_Context](#hms_llmengine_context)|定义LLM引擎上下文的别名。|
|typedef struct [HMS_LLMEngine_Executor](#hms_llmengine_executor) [HMS_LLMEngine_Executor](#hms_llmengine_executor)|LLM引擎执行器。|
|typedef struct [HMS_LLMEngine_Prompt](#hms_llmengine_prompt) [HMS_LLMEngine_Prompt](#hms_llmengine_prompt)|LLM引擎文本输入。|
|typedef void(* [callbackFunctionType](#callbackfunctiontype)) (const [HMS_LLMEngine_Context](#hms_llmengine_context) *)|生成回调函数。|

### 枚举

> phone | 2in1 | tablet | tv

|名称|描述|
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------|
|[HiAI_ImageFormat](#hiai_imageformat) { HIAI_YUV420SP_U8 = 0, HIAI_XRGB8888_U8 = 1, HIAI_YUV400_U8 = 2, HIAI_ARGB8888_U8 = 3, HIAI_YUYV_U8 = 4, HIAI_YUV422SP_U8 = 5, HIAI_AYUV444_U8 = 6, HIAI_RGB888_U8 = 7, HIAI_BGR888_U8 = 8, HIAI_YUV444SP_U8 = 9, HIAI_YVU444SP_U8 = 10, HIAI_IMAGE_FORMAT_INVALID = 255 }|CANN Kit推理支持的输入和输出Tensor的图片格式的枚举。|
|[HiAI_ImageColorSpace](#hiai_imagecolorspace) { HIAI_JPEG = 0, HIAI_BT_601_NARROW = 1, HIAI_BT_601_FULL = 2, HIAI_BT_709_NARROW = 3, HIAI_IMAGE_COLOR_SPACE_INVALID = 4 }|图像色域空间类型。|
|[HiAI_Compatibility](#hiai_compatibility) { HIAI_COMPATIBILITY_COMPATIBLE = 0, HIAI_COMPATIBILITY_INCOMPATIBLE = 1 }|编译后模型兼容性结果。|
|[HiAI_FormatMode](#hiai_formatmode) { HIAI_FORMAT_MODE_NCHW = 0, HIAI_FORMAT_MODE_ORIGIN = 1 }|模型编译时数据的排列格式。|
|[HiAI_DynamicShapeStatus](#hiai_dynamicshapestatus) { HIAI_DYNAMIC_SHAPE_DISABLED = 0, HIAI_DYNAMIC_SHAPE_ENABLED = 1 }|是否使能编译前可变shape。|
|[HiAI_DynamicShapeCacheMode](#hiai_dynamicshapecachemode) { HIAI_DYNAMIC_SHAPE_CACHE_BUILT_MODEL = 0, HIAI_DYNAMIC_SHAPE_CACHE_LOADED_MODEL = 1 }|编译前可变shape支持的模式。|
|[HiAI_ExecuteDevice](#hiai_executedevice) { HIAI_EXECUTE_DEVICE_NPU = 0, HIAI_EXECUTE_DEVICE_CPU = 1, HIAI_EXECUTE_DEVICE_GPU = 2 }|模型运行时支持的设备类型。|
|[HiAI_FallbackMode](#hiai_fallbackmode) { HIAI_FALLBACK_ENABLED = 0, HIAI_FALLBACK_DISABLED = 1 }|指定的硬件设备无法编译模型时，是否允许CANN Kit选择其他硬件设备，例如CPU。|
|[HiAI_DeviceMemoryReusePlan](#hiai_devicememoryreuseplan) { HIAI_DEVICE_MEMORY_REUSE_PLAN_UNSET = 0, HIAI_DEVICE_MEMORY_REUSE_PLAN_LOW = 1, HIAI_DEVICE_MEMORY_REUSE_PLAN_HIGH = 2 }|设备内存复用配置选项。|
|[HiAI_TuningStrategy](#hiai_tuningstrategy) { HIAI_TUNING_STRATEGY_OFF = 0, HIAI_TUNING_STRATEGY_ON_DEVICE_TUNING = 1, HIAI_TUNING_STRATEGY_ON_DEVICE_PREPROCESS_TUNING = 2, HIAI_TUNING_STRATEGY_ON_CLOUD_TUNING = 3 }|模型优化策略配置选项。|
|[HiAI_TuningMode](#hiai_tuningmode) { HIAI_TUNING_MODE_UNSET = 0, HIAI_TUNING_MODE_AUTO = 1, HIAI_TUNING_MODE_HETER = 2 }|辅助调优模式。|
|[HiAI_BandMode](#hiai_bandmode) { HIAI_BANDMODE_UNSET = 0, HIAI_BANDMODE_LOW = 1, HIAI_BANDMODE_NORMAL = 2, HIAI_BANDMODE_HIGH = 3 }|定义硬件之间带宽模式。|
|[HiAI_OmType](#hiai_omtype) { HIAI_OM_TYPE_OFF = 0, HIAI_OM_TYPE_PROFILING = 1, HIAI_OM_TYPE_DUMP = 2 }|维测类型定义。|
|[HiAI_SingleOpDataType](#hiai_singleopdatatype) { HIAI_SINGLEOP_DT_FLOAT = 0, HIAI_SINGLEOP_DT_FLOAT16 = 1, HIAI_SINGLEOP_DT_UNDEFINED = 17 }|单算子张量数据类型枚举。|
|[HiAI_SingleOpFormat](#hiai_singleopformat) { HIAI_SINGLEOP_FORMAT_NCHW = 0, HIAI_SINGLEOP_FORMAT_NHWC = 1, HIAI_SINGLEOP_FORMAT_ND = 2, HIAI_SINGLEOP_FORMAT_NC1HWC0 = 3, HIAI_SINGLEOP_FORMAT_NC4HW4 = 28, HIAI_SINGLEOP_FORMAT_NC8HW8 = 31, HIAI_SINGLEOP_FORMAT_RESERVED = 255 }|单算子张量排布格式枚举。|
|[HiAI_SingleOpConvMode](#hiai_singleopconvmode) { HIAI_SINGLEOP_CONV_MODE_COMMON = 0, HIAI_SINGLEOP_CONV_MODE_TRANSPOSED = 1, HIAI_SINGLEOP_CONV_MODE_DEPTHWISE = 2 }|单算子卷积模式枚举。|
|[HiAI_SingleOpPadMode](#hiai_singleoppadmode) { HIAI_SINGLEOP_PAD_MODE_SPECIFIC = 0, HIAI_SINGLEOP_PAD_MODE_SAME = 1, HIAI_SINGLEOP_PAD_MODE_SAME_UPPER = 2, HIAI_SINGLEOP_PAD_MODE_SAME_LOWER = 3, HIAI_SINGLEOP_PAD_MODE_VALID = 4 }|单算子填充模式枚举。|
|[HiAI_SingleOpActivationType](#hiai_singleopactivationtype) { HIAI_SINGLEOP_ACTIVATION_TYPE_RELU = 0, HIAI_SINGLEOP_ACTIVATION_TYPE_RELU6 = 1 }|单算子激活模式枚举。|
|[HiAI_SingleOpSupportStatus](#hiai_singleopsupportstatus) { HIAI_SINGLEOP_OPTIMIZED = 0, HIAI_SINGLEOP_COMMON = 1, HIAI_SINGLEOP_UNSUPPORTED = 2 }|单算子支持状态枚举。|
|[HMS_LLMEngine_InferPerfMode](#hms_llmengine_inferperfmode) { HMS_LLMENGINE_INFERPERF_UNSET = 0, HMS_LLMENGINE_INFERPERF_LOW, HMS_LLMENGINE_INFERPERF_MIDDLE, HMS_LLMENGINE_INFERPERF_HIGH, HMS_LLMENGINE_INFERPERF_EXTREME_HIGH }|推断性能模式。|

### 函数

> phone | 2in1 | tablet | tv

|名称|描述|
|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------|
|[HiAI_AippParam](#hiai_aippparam) * [HMS_HiAIAippParam_Create](#hms_hiaiaippparam_create) (uint32_t batchNum)|根据batchNum创建动态AippParam对象。|
|void * [HMS_HiAIAippParam_GetData](#hms_hiaiaippparam_getdata) ([HiAI_AippParam](#hiai_aippparam) *aippParam)|获取AippParam申请的内存地址。|
|uint32_t [HMS_HiAIAippParam_GetDataSize](#hms_hiaiaippparam_getdatasize) ([HiAI_AippParam](#hiai_aippparam) *aippParam)|获取AippParam申请的内存大小。|
|int [HMS_HiAIAippParam_GetInputIndex](#hms_hiaiaippparam_getinputindex) ([HiAI_AippParam](#hiai_aippparam) *aippParam)|查询AippParam对象所在输入的索引。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_SetInputIndex](#hms_hiaiaippparam_setinputindex) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t inputIndex)|设置AippParam在输入上的索引。|
|int [HMS_HiAIAippParam_GetInputAippIndex](#hms_hiaiaippparam_getinputaippindex) ([HiAI_AippParam](#hiai_aippparam) *aippParam)|查询AippParam对象在该输入的多个输出分支上的索引。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_SetInputAippIndex](#hms_hiaiaippparam_setinputaippindex) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t inputAippIndex)|设置AippParam对象作用于该输入的多个输出分支上的索引。|
|void [HMS_HiAIAippParam_Destroy](#hms_hiaiaippparam_destroy) ([HiAI_AippParam](#hiai_aippparam) **aippParam)|释放AippParam对象。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_SetInputFormat](#hms_hiaiaippparam_setinputformat) ([HiAI_AippParam](#hiai_aippparam) *aippParam, [HiAI_ImageFormat](#hiai_imageformat) inputFormat)|设置AippParam对象的输入图像格式。|
|[HiAI_ImageFormat](#hiai_imageformat) [HMS_HiAIAippParam_GetInputFormat](#hms_hiaiaippparam_getinputformat) ([HiAI_AippParam](#hiai_aippparam) *aippParam)|查询AippParam对象的输入图像格式。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_SetInputShape](#hms_hiaiaippparam_setinputshape) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t srcImageW, uint32_t srcImageH)|设置AippParam对象的输入图像宽高。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_GetInputShape](#hms_hiaiaippparam_getinputshape) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t *srcImageW, uint32_t *srcImageH)|查询AippParam对象的输入图像宽高。|
|uint32_t [HMS_HiAIAippParam_GetBatchCount](#hms_hiaiaippparam_getbatchcount) ([HiAI_AippParam](#hiai_aippparam) *aippParam)|查询AippParam对象的图像数量。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_SetCscConfig](#hms_hiaiaippparam_setcscconfig) ([HiAI_AippParam](#hiai_aippparam) *aippParam, [HiAI_ImageFormat](#hiai_imageformat) inputFormat, [HiAI_ImageFormat](#hiai_imageformat) outputFormat, [HiAI_ImageColorSpace](#hiai_imagecolorspace) space)|设置AippParam对象的CSC色域转换参数。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_GetCscConfig](#hms_hiaiaippparam_getcscconfig) ([HiAI_AippParam](#hiai_aippparam) *aippParam, [HiAI_ImageFormat](#hiai_imageformat) *inputFormat, [HiAI_ImageFormat](#hiai_imageformat) *outputFormat, [HiAI_ImageColorSpace](#hiai_imagecolorspace) *space)|查询AippParam对象的CSC色域转换相关参数。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_SetChannelSwapConfig](#hms_hiaiaippparam_setchannelswapconfig) ([HiAI_AippParam](#hiai_aippparam) *aippParam, bool rbuvSwapSwitch, bool axSwapSwitch)|设置AippParam对象的ChannelSwap通道交换参数。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_GetChannelSwapConfig](#hms_hiaiaippparam_getchannelswapconfig) ([HiAI_AippParam](#hiai_aippparam) *aippParam, bool *rbuvSwapSwitch, bool *axSwapSwitch)|查询AippParam对象的ChannelSwap通道交换参数。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_SetSingleBatchMultiCrop](#hms_hiaiaippparam_setsinglebatchmulticrop) ([HiAI_AippParam](#hiai_aippparam) *aippParam, bool singleBatchMultiCrop)|设置AippParam对象的SingleBatchMultiCrop标识。|
|bool [HMS_HiAIAippParam_GetSingleBatchMultiCrop](#hms_hiaiaippparam_getsinglebatchmulticrop) ([HiAI_AippParam](#hiai_aippparam) *aippParam)|查询AippParam对象的SingleBatchMultiCrop标识。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_SetCropConfig](#hms_hiaiaippparam_setcropconfig) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, uint32_t startPosW, uint32_t startPosH, uint32_t croppedW, uint32_t croppedH)|设置AippParam对象的裁剪参数。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_GetCropConfig](#hms_hiaiaippparam_getcropconfig) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, uint32_t *startPosW, uint32_t *startPosH, uint32_t *croppedW, uint32_t *croppedH)|查询AippParam对象的裁剪参数。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_SetResizeConfig](#hms_hiaiaippparam_setresizeconfig) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, uint32_t resizedW, uint32_t resizedH)|设置AippParam对象的图像缩放参数。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_GetResizeConfig](#hms_hiaiaippparam_getresizeconfig) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, uint32_t *resizedW, uint32_t *resizedH)|查询AippParam对象的图像缩放参数。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_SetPadConfig](#hms_hiaiaippparam_setpadconfig) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, uint32_t leftPadSize, uint32_t rightPadSize, uint32_t topPadSize, uint32_t bottomPadSize)|设置AippParam对象的输入图像的填充像素数。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_GetPadConfig](#hms_hiaiaippparam_getpadconfig) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, uint32_t *leftPadSize, uint32_t *rightPadSize, uint32_t *topPadSize, uint32_t *bottomPadSize)|查询AippParam对象的输入图像的填充像素数。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_SetChannelPadding](#hms_hiaiaippparam_setchannelpadding) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, uint32_t paddingValues[], uint32_t channelCount)|设置AippParam对象的通道padding填充值。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_GetChannelPadding](#hms_hiaiaippparam_getchannelpadding) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, uint32_t paddingValues[], uint32_t channelCount)|查询AippParam对象的通道padding填充值。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_SetRotationAngle](#hms_hiaiaippparam_setrotationangle) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, float rotationAngle)|设置AippParam对象的旋转角度。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_GetRotationAngle](#hms_hiaiaippparam_getrotationangle) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, float *rotationAngle)|查询AippParam对象的图像旋转角度。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_SetDtcMeanPixel](#hms_hiaiaippparam_setdtcmeanpixel) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, uint32_t meanPixel[], uint32_t channelCount)|设置AippParam对象的数据类型转换通道像素平均值。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_GetDtcMeanPixel](#hms_hiaiaippparam_getdtcmeanpixel) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, uint32_t meanPixel[], uint32_t channelCount)|查询AippParam对象的数据类型转换通道像素平均值。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_SetDtcMinPixel](#hms_hiaiaippparam_setdtcminpixel) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, float minPixel[], uint32_t channelCount)|设置AippParam对象的数据类型转换通道像素最小值。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_GetDtcMinPixel](#hms_hiaiaippparam_getdtcminpixel) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, float minPixel[], uint32_t channelCount)|查询AippParam对象的数据类型转换通道像素最小值。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_SetDtcVarReciPixel](#hms_hiaiaippparam_setdtcvarrecipixel) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, float varReciPixel[], uint32_t channelCount)|设置AippParam对象的数据类型转换通道像素方差。|
|OH_NN_ReturnCode [HMS_HiAIAippParam_GetDtcVarReciPixel](#hms_hiaiaippparam_getdtcvarrecipixel) ([HiAI_AippParam](#hiai_aippparam) *aippParam, uint32_t batchIndex, float varReciPixel[], uint32_t channelCount)|查询AippParam对象的数据类型转换通道像素方差。|
|const char * [HMS_HiAI_GetVersion](#hms_hiai_getversion) (void)|获取CANN Kit版本号，并通过返回模板hiaiversion A~1~A~2~A~3~.X~1~X~2~X~3~.Y~1~Y~2~Y~3~.Z~1~Z~2~Z~3~指定X~1~是否为0来区分是否支持NPU。若X~1~为0，则表示不支持NPU；若X~1~为非0，则表示支持NPU。|
|[HiAI_Compatibility](#hiai_compatibility) [HMS_HiAICompatibility_CheckFromFile](#hms_hiaicompatibility_checkfromfile) (const char *file)|查询编译后储存在文件中的模型的兼容性。 若发生不兼容情况，建议重新编译模型。|
|[HiAI_Compatibility](#hiai_compatibility) [HMS_HiAICompatibility_CheckFromBuffer](#hms_hiaicompatibility_checkfrombuffer) (const void *data, size_t size)|查询编译后储存在内存中的模型的兼容性。 若发生不兼容情况，建议重新编译模型。|
|OH_NN_ReturnCode [HMS_HiAIOptions_SetInputTensorShapes](#hms_hiaioptions_setinputtensorshapes) (OH_NNCompilation *compilation, NN_TensorDesc *inputTensorDescs[], size_t shapeCount)|编译时更新模型输入shape。|
|size_t [HMS_HiAIOptions_GetInputTensorShapeSize](#hms_hiaioptions_getinputtensorshapesize) (const OH_NNCompilation *compilation)|查询选项参数中shape描述的个数。|
|NN_TensorDesc * [HMS_HiAIOptions_GetInputTensorShape](#hms_hiaioptions_getinputtensorshape) (const OH_NNCompilation *compilation, size_t index)|查询选项参数中指定索引的shape描述。|
|OH_NN_ReturnCode [HMS_HiAIOptions_SetFormatMode](#hms_hiaioptions_setformatmode) (OH_NNCompilation *compilation, [HiAI_FormatMode](#hiai_formatmode) formatMode)|设置模型编译时的数据排列格式。|
|[HiAI_FormatMode](#hiai_formatmode) [HMS_HiAIOptions_GetFormatMode](#hms_hiaioptions_getformatmode) (const OH_NNCompilation *compilation)|查询模型编译参数中的数据排列格式。|
|OH_NN_ReturnCode [HMS_HiAIOptions_SetDynamicShapeStatus](#hms_hiaioptions_setdynamicshapestatus) (OH_NNCompilation *compilation, [HiAI_DynamicShapeStatus](#hiai_dynamicshapestatus) status)|设置编译前可变shape配置中的EnableMode参数。|
|OH_NN_ReturnCode [HMS_HiAIOptions_SetDynamicShapeMaxCache](#hms_hiaioptions_setdynamicshapemaxcache) (OH_NNCompilation *compilation, size_t maxCacheCount)|设置编译前可变shape配置中的最大缓存编译后模型数量。|
|OH_NN_ReturnCode [HMS_HiAIOptions_SetDynamicShapeCacheMode](#hms_hiaioptions_setdynamicshapecachemode) (OH_NNCompilation *compilation, [HiAI_DynamicShapeCacheMode](#hiai_dynamicshapecachemode) mode)|设置编译前可变shape配置中的缓存模式参数。|
|[HiAI_DynamicShapeStatus](#hiai_dynamicshapestatus) [HMS_HiAIOptions_GetDynamicShapeStatus](#hms_hiaioptions_getdynamicshapestatus) (const OH_NNCompilation *compilation)|查询编译前可变shape配置中的状态参数。|
|size_t [HMS_HiAIOptions_GetDynamicShapeMaxCache](#hms_hiaioptions_getdynamicshapemaxcache) (const OH_NNCompilation *compilation)|查询编译前可变shape配置中的最大缓存数量。|
|[HiAI_DynamicShapeCacheMode](#hiai_dynamicshapecachemode) [HMS_HiAIOptions_GetDynamicShapeCacheMode](#hms_hiaioptions_getdynamicshapecachemode) (const OH_NNCompilation *compilation)|查询编译前可变shape配置中的cacheMode参数。|
|OH_NN_ReturnCode [HMS_HiAIOptions_SetOperatorDeviceOrder](#hms_hiaioptions_setoperatordeviceorder) (OH_NNCompilation *compilation, const char *operatorName, [HiAI_ExecuteDevice](#hiai_executedevice) *executeDevices, size_t deviceCount)|设置算子级调优配置中算子执行设备列表。|
|size_t [HMS_HiAIOptions_GetOperatorDeviceCount](#hms_hiaioptions_getoperatordevicecount) (const OH_NNCompilation *compilation, const char *operatorName)|查询算子级调优配置中指定算子的执行设备个数。|
|[HiAI_ExecuteDevice](#hiai_executedevice) * [HMS_HiAIOptions_GetOperatorDeviceOrder](#hms_hiaioptions_getoperatordeviceorder) (const OH_NNCompilation *compilation, const char *operatorName)|查询算子级调优配置中指定算子的执行设备列表。|
|OH_NN_ReturnCode [HMS_HiAIOptions_SetModelDeviceOrder](#hms_hiaioptions_setmodeldeviceorder) (OH_NNCompilation *compilation, [HiAI_ExecuteDevice](#hiai_executedevice) *executeDevices, size_t deviceCount)|设置模型级调优配置中模型执行设备列表。|
|size_t [HMS_HiAIOptions_GetModelDeviceCount](#hms_hiaioptions_getmodeldevicecount) (const OH_NNCompilation *compilation)|查询模型级调优配置中模型的执行设备个数。|
|[HiAI_ExecuteDevice](#hiai_executedevice) * [HMS_HiAIOptions_GetModelDeviceOrder](#hms_hiaioptions_getmodeldeviceorder) (const OH_NNCompilation *compilation)|查询模型级调优配置中模型的执行设备列表。|
|OH_NN_ReturnCode [HMS_HiAIOptions_SetFallbackMode](#hms_hiaioptions_setfallbackmode) (OH_NNCompilation *compilation, [HiAI_FallbackMode](#hiai_fallbackmode) fallbackMode)|设置调优配置中的回滚模式。|
|[HiAI_FallbackMode](#hiai_fallbackmode) [HMS_HiAIOptions_GetFallbackMode](#hms_hiaioptions_getfallbackmode) (const OH_NNCompilation *compilation)|查询调优配置中的回滚模式。|
|OH_NN_ReturnCode [HMS_HiAIOptions_SetDeviceMemoryReusePlan](#hms_hiaioptions_setdevicememoryreuseplan) (OH_NNCompilation *compilation, [HiAI_DeviceMemoryReusePlan](#hiai_devicememoryreuseplan) deviceMemoryReusePlan)|设置调优配置中的设备内存复用参数。|
|[HiAI_DeviceMemoryReusePlan](#hiai_devicememoryreuseplan) [HMS_HiAIOptions_GetDeviceMemoryReusePlan](#hms_hiaioptions_getdevicememoryreuseplan) (const OH_NNCompilation *compilation)|查询调优配置中的设备内存复用参数。|
|OH_NN_ReturnCode [HMS_HiAIOptions_SetTuningStrategy](#hms_hiaioptions_settuningstrategy) (OH_NNCompilation *compilation, [HiAI_TuningStrategy](#hiai_tuningstrategy) tuningStrategy)|设置模型编译时的模型优化策略。|
|[HiAI_TuningStrategy](#hiai_tuningstrategy) [HMS_HiAIOptions_GetTuningStrategy](#hms_hiaioptions_gettuningstrategy) (const OH_NNCompilation *compilation)|查询模型优化策略。|
|OH_NN_ReturnCode [HMS_HiAIOptions_SetQuantConfig](#hms_hiaioptions_setquantconfig) (OH_NNCompilation *compilation, void *data, size_t size)|设置模型编译时量化配置。|
|void * [HMS_HiAIOptions_GetQuantConfigData](#hms_hiaioptions_getquantconfigdata) (const OH_NNCompilation *compilation)|查询量化配置的数据地址。|
|size_t [HMS_HiAIOptions_GetQuantConfigSize](#hms_hiaioptions_getquantconfigsize) (const OH_NNCompilation *compilation)|查询量化配置的数据大小。|
|OH_NN_ReturnCode [HMS_HiAIOptions_SetTuningMode](#hms_hiaioptions_settuningmode) (OH_NNCompilation *compilation, [HiAI_TuningMode](#hiai_tuningmode) tuningMode)|选择辅助调优模式。|
|OH_NN_ReturnCode [HMS_HiAIOptions_SetTuningCacheDir](#hms_hiaioptions_settuningcachedir) (OH_NNCompilation *compilation, const char *cacheDir)|设置辅助调优的缓存目录。|
|[HiAI_TuningMode](#hiai_tuningmode) [HMS_HiAIOptions_GetTuningMode](#hms_hiaioptions_gettuningmode) (const OH_NNCompilation *compilation)|查询辅助调优模式。|
|const char * [HMS_HiAIOptions_GetTuningCacheDir](#hms_hiaioptions_gettuningcachedir) (const OH_NNCompilation *compilation)|查询辅助调优的缓存目录。|
|OH_NN_ReturnCode [HMS_HiAIOptions_SetBandMode](#hms_hiaioptions_setbandmode) (OH_NNCompilation *compilation, [HiAI_BandMode](#hiai_bandmode) bandMode)|设置NPU与周边硬件IO资源的带宽模式。|
|[HiAI_BandMode](#hiai_bandmode) [HMS_HiAIOptions_GetBandMode](#hms_hiaioptions_getbandmode) (const OH_NNCompilation *compilation)|查询带宽模式。|
|OH_NN_ReturnCode [HMS_HiAIOptions_SetOmOptions](#hms_hiaioptions_setomoptions) (OH_NNCompilation *compilation, [HiAI_OmType](#hiai_omtype) type, const char *outputDir)|设置模型加载时的维测选项信息。|
|[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc) * [HMS_HiAISingleOpTensorDesc_Create](#hms_hiaisingleoptensordesc_create) (const int64_t *dims, size_t dimNum, [HiAI_SingleOpDataType](#hiai_singleopdatatype) dataType, [HiAI_SingleOpFormat](#hiai_singleopformat) format, bool isVirtual)|创建[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象。|
|size_t [HMS_HiAISingleOpTensorDesc_GetDimensionCount](#hms_hiaisingleoptensordesc_getdimensioncount) (const [HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc) *tensorDesc)|查询[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)的维度数量。|
|int64_t [HMS_HiAISingleOpTensorDesc_GetDimension](#hms_hiaisingleoptensordesc_getdimension) (const [HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc) *tensorDesc, size_t index)|查询[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)指定索引的维度长度。|
|[HiAI_SingleOpDataType](#hiai_singleopdatatype) [HMS_HiAISingleOpTensorDesc_GetDataType](#hms_hiaisingleoptensordesc_getdatatype) (const [HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc) *tensorDesc)|查询[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)的数据类型。|
|[HiAI_SingleOpFormat](#hiai_singleopformat) [HMS_HiAISingleOpTensorDesc_GetFormat](#hms_hiaisingleoptensordesc_getformat) (const [HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc) *tensorDesc)|查询[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)的排布格式。|
|bool [HMS_HiAISingleOpTensorDesc_IsVirtual](#hms_hiaisingleoptensordesc_isvirtual) (const [HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc) *tensorDesc)|查询[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)是否为虚拟张量。|
|size_t [HMS_HiAISingleOpTensorDesc_GetByteSize](#hms_hiaisingleoptensordesc_getbytesize) (const [HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc) *tensorDesc)|查询基于[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)的维度和数据类型计算的数据占用字节数。|
|void [HMS_HiAISingleOpTensorDesc_Destroy](#hms_hiaisingleoptensordesc_destroy) ([HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc) **tensorDesc)|释放[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象。|
|[HiAI_SingleOpBuffer](#hiai_singleopbuffer) * [HMS_HiAISingleOpBuffer_Create](#hms_hiaisingleopbuffer_create) (size_t dataSize)|按照指定的内存大小创建[HiAI_SingleOpBuffer](#hiai_singleopbuffer)对象。|
|size_t [HMS_HiAISingleOpBuffer_GetSize](#hms_hiaisingleopbuffer_getsize) (const [HiAI_SingleOpBuffer](#hiai_singleopbuffer) *buffer)|查询[HiAI_SingleOpBuffer](#hiai_singleopbuffer)的字节大小。|
|void * [HMS_HiAISingleOpBuffer_GetData](#hms_hiaisingleopbuffer_getdata) (const [HiAI_SingleOpBuffer](#hiai_singleopbuffer) *buffer)|查询[HiAI_SingleOpBuffer](#hiai_singleopbuffer)的内存地址。|
|OH_NN_ReturnCode [HMS_HiAISingleOpBuffer_Destroy](#hms_hiaisingleopbuffer_destroy) ([HiAI_SingleOpBuffer](#hiai_singleopbuffer) **buffer)|释放[HiAI_SingleOpBuffer](#hiai_singleopbuffer)对象。|
|[HiAI_SingleOpTensor](#hiai_singleoptensor) * [HMS_HiAISingleOpTensor_CreateFromTensorDesc](#hms_hiaisingleoptensor_createfromtensordesc) (const [HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc) *desc)|根据[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)创建[HiAI_SingleOpTensor](#hiai_singleoptensor)对象。|
|[HiAI_SingleOpTensor](#hiai_singleoptensor) * [HMS_HiAISingleOpTensor_CreateFromSingleOpBuffer](#hms_hiaisingleoptensor_createfromsingleopbuffer) (const [HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc) *desc, void *data, size_t dataSize)|根据[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)、[HiAI_SingleOpBuffer](#hiai_singleopbuffer)的内存地址和数据大小创建[HiAI_SingleOpTensor](#hiai_singleoptensor)对象。|
|[HiAI_SingleOpTensor](#hiai_singleoptensor) * [HMS_HiAISingleOpTensor_CreateFromConst](#hms_hiaisingleoptensor_createfromconst) (const [HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc) *desc, void *data, size_t dataSize)|根据[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)、常量数据（如卷积权重、偏置等）的内存地址和数据大小创建[HiAI_SingleOpTensor](#hiai_singleoptensor)对象。|
|[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc) * [HMS_HiAISingleOpTensor_GetTensorDesc](#hms_hiaisingleoptensor_gettensordesc) (const [HiAI_SingleOpTensor](#hiai_singleoptensor) *tensor)|获取[HiAI_SingleOpTensor](#hiai_singleoptensor)的Tensor描述。|
|[HiAI_SingleOpBuffer](#hiai_singleopbuffer) * [HMS_HiAISingleOpTensor_GetBuffer](#hms_hiaisingleoptensor_getbuffer) (const [HiAI_SingleOpTensor](#hiai_singleoptensor) *tensor)|获取[HiAI_SingleOpTensor](#hiai_singleoptensor)的Buffer。|
|OH_NN_ReturnCode [HMS_HiAISingleOpTensor_Destroy](#hms_hiaisingleoptensor_destroy) ([HiAI_SingleOpTensor](#hiai_singleoptensor) **tensor)|释放[HiAI_SingleOpTensor](#hiai_singleoptensor)对象。|
|[HiAI_SingleOpOptions](#hiai_singleopoptions) * [HMS_HiAISingleOpOptions_Create](#hms_hiaisingleopoptions_create) (void)|创建[HiAI_SingleOpOptions](#hiai_singleopoptions)对象。|
|void [HMS_HiAISingleOpOptions_Destroy](#hms_hiaisingleopoptions_destroy) ([HiAI_SingleOpOptions](#hiai_singleopoptions) **options)|释放[HiAI_SingleOpOptions](#hiai_singleopoptions)对象。|
|[HiAI_SingleOpDescriptor](#hiai_singleopdescriptor) * [HMS_HiAISingleOpDescriptor_CreateConvolution](#hms_hiaisingleopdescriptor_createconvolution) ([HiAISingleOpDescriptor_ConvolutionParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopdesc-convparam) param)|创建卷积类（普通卷积、转置卷积、深度卷积）的描述符对象。|
|[HiAI_SingleOpDescriptor](#hiai_singleopdescriptor) * [HMS_HiAISingleOpDescriptor_CreateActivation](#hms_hiaisingleopdescriptor_createactivation) ([HiAI_SingleOpActivationType](#hiai_singleopactivationtype) activationType, float coef)|创建激活函数类的描述符对象。|
|void [HMS_HiAISingleOpDescriptor_Destroy](#hms_hiaisingleopdescriptor_destroy) ([HiAI_SingleOpDescriptor](#hiai_singleopdescriptor) **opDesc)|释放[HiAI_SingleOpDescriptor](#hiai_singleopdescriptor)对象。|
|[HiAI_SingleOpSupportStatus](#hiai_singleopsupportstatus) [HMS_HiAISingleOpExecutor_PreCheckConvolution](#hms_hiaisingleopexecutor_precheckconvolution) ([HiAI_SingleOpExecutorConvolutionParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopexec-convparam) param)|预查询卷积算子的支持状态。|
|[HiAI_SingleOpSupportStatus](#hiai_singleopsupportstatus) [HMS_HiAISingleOpExecutor_PreCheckFusedConvolutionActivation](#hms_hiaisingleopexecutor_precheckfusedconvolutionactivation) ([HiAI_SingleOpExecutorFusedConvolutionActivationParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopexec-fusedconv-actparam) param)|预查询卷积和激活融合算子的支持状态。|
|[HiAI_SingleOpExecutor](#hiai_singleopexecutor) * [HMS_HiAISingleOpExecutor_CreateConvolution](#hms_hiaisingleopexecutor_createconvolution) ([HiAI_SingleOpExecutorConvolutionParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopexec-convparam) param)|创建卷积类算子对应的[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象。|
|[HiAI_SingleOpExecutor](#hiai_singleopexecutor) * [HMS_HiAISingleOpExecutor_CreateFusedConvolutionActivation](#hms_hiaisingleopexecutor_createfusedconvolutionactivation) ([HiAI_SingleOpExecutorFusedConvolutionActivationParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopexec-fusedconv-actparam) param)|创建卷积和激活融合算子对应的[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象。|
|OH_NN_ReturnCode [HMS_HiAISingleOpExecutor_UpdateOutputTensorDesc](#hms_hiaisingleopexecutor_updateoutputtensordesc) (const [HiAI_SingleOpExecutor](#hiai_singleopexecutor) *executor, uint32_t index, [HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc) *output)|更新[HiAI_SingleOpExecutor](#hiai_singleopexecutor)的输出tensor描述。|
|size_t [HMS_HiAISingleOpExecutor_GetWorkspaceSize](#hms_hiaisingleopexecutor_getworkspacesize) (const [HiAI_SingleOpExecutor](#hiai_singleopexecutor) *executor)|查询[HiAI_SingleOpExecutor](#hiai_singleopexecutor)所需的ION内存工作空间的字节大小。|
|OH_NN_ReturnCode [HMS_HiAISingleOpExecutor_Init](#hms_hiaisingleopexecutor_init) ([HiAI_SingleOpExecutor](#hiai_singleopexecutor) *executor, void *workspace, size_t workspaceSize)|加载[HiAI_SingleOpExecutor](#hiai_singleopexecutor)。|
|OH_NN_ReturnCode [HMS_HiAISingleOpExecutor_Execute](#hms_hiaisingleopexecutor_execute) ([HiAI_SingleOpExecutor](#hiai_singleopexecutor) *executor, [HiAI_SingleOpTensor](#hiai_singleoptensor) *input[], int32_t inputNum, [HiAI_SingleOpTensor](#hiai_singleoptensor) *output[], int32_t outputNum)|执行同步运算推理。|
|OH_NN_ReturnCode [HMS_HiAISingleOpExecutor_Destroy](#hms_hiaisingleopexecutor_destroy) ([HiAI_SingleOpExecutor](#hiai_singleopexecutor) **executor)|销毁[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象，释放执行器占用的内存。|
|size_t [HMS_HiAITensor_GetSizeWithImageFormat](#hms_hiaitensor_getsizewithimageformat) (NN_TensorDesc *desc, [HiAI_ImageFormat](#hiai_imageformat) format)|根据NN_TensorDesc和HiAI_ImageFormat计算申请tensor的大小。|
|OH_NN_ReturnCode [HMS_HiAITensor_SetAippParams](#hms_hiaitensor_setaippparams) (NN_Tensor *tensor, [HiAI_AippParam](#hiai_aippparam) *aippParams[], size_t aippNum)|给NN_Tensor设置AippParams。|
|[HMS_LLMEngine_Context](#hms_llmengine_context) * [HMS_LLMEngineContext_CreateFromContextJson](#hms_llmenginecontext_createfromcontextjson) (const char *jsonFile)|通过JSON配置文件创建LLM引擎上下文句柄。|
|void [HMS_LLMEngine_Context_Destroy](#hms_llmengine_context_destroy) ([HMS_LLMEngine_Context](#hms_llmengine_context) **ctx)|销毁LLM引擎上下文。|
|[HMS_LLMEngine_Executor](#hms_llmengine_executor) * [HMS_LLMEngineExecutor_CreateFromExecutorJson](#hms_llmengineexecutor_createfromexecutorjson) (const char *jsonFile)|通过JSON配置文件创建LLM引擎执行器句柄。|
|void [HMS_LLMEngineExecutor_Destroy](#hms_llmengineexecutor_destroy) ([HMS_LLMEngine_Executor](#hms_llmengine_executor) **executor)|销毁一个LLM引擎执行器，该执行器内存释放。|
|[HMS_LLMEngine_Prompt](#hms_llmengine_prompt) * [HMS_LLMEnginePrompt_Create](#hms_llmengineprompt_create) (void)|创建一个LLM引擎提示句柄。|
|OH_NN_ReturnCode [HMS_LLMEnginePrompt_SetText](#hms_llmengineprompt_settext) ([HMS_LLMEngine_Prompt](#hms_llmengine_prompt) *prompt, const char *text)|设置文本输入。|
|OH_NN_ReturnCode [HMS_LLMEnginePrompt_SetTokenId](#hms_llmengineprompt_settokenid) ([HMS_LLMEngine_Prompt](#hms_llmengine_prompt) *prompt, int32_t *tokenIds, uint32_t tokenNum)|设置输入的tokenid。|
|void [HMS_LLMEnginePrompt_Destroy](#hms_llmengineprompt_destroy) ([HMS_LLMEngine_Prompt](#hms_llmengine_prompt) **prompt)|销毁LLM引擎提示词句柄。|
|OH_NN_ReturnCode [HMS_LLMEngineContext_SetOnOneTokenGenerateDoneFunc](#hms_llmenginecontext_setononetokengeneratedonefunc) ([HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, [callbackFunctionType](#callbackfunctiontype) func)|设置生成token时触发的回调函数。|
|OH_NN_ReturnCode [HMS_LLMEngineContext_SetOnAllTokensGenerateDoneFunc](#hms_llmenginecontext_setonalltokensgeneratedonefunc) ([HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, [callbackFunctionType](#callbackfunctiontype) func)|设置所有token生成完毕时触发的回调函数。|
|OH_NN_ReturnCode [HMS_LLMEngineContext_SetOnGenerateAsyncFailed](#hms_llmenginecontext_setongenerateasyncfailed) ([HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, [callbackFunctionType](#callbackfunctiontype) func)|设置生成失败时的回调函数。|
|OH_NN_ReturnCode [HMS_LLMEngineContext_GetOneGenerationLen](#hms_llmenginecontext_getonegenerationlen) (const [HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, uint32_t *len)|获取生成文本片段的长度。|
|OH_NN_ReturnCode [HMS_LLMEngineContext_GetOneGeneration](#hms_llmenginecontext_getonegeneration) (const [HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, char *generation, uint32_t len)|获取生成的文本片段。|
|OH_NN_ReturnCode [HMS_LLMEngineContext_GetAllGenerationLen](#hms_llmenginecontext_getallgenerationlen) (const [HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, uint32_t *len)|获取所有生成文本的总长度。|
|OH_NN_ReturnCode [HMS_LLMEngineContext_GetAllGeneration](#hms_llmenginecontext_getallgeneration) (const [HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, char *generation, uint32_t len)|获取所有生成的文本。|
|OH_NN_ReturnCode [HMS_LLMEngineContext_GetOneTokenGeneration](#hms_llmenginecontext_getonetokengeneration) (const [HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, int32_t *genToken)|获取生成的tokenid。|
|OH_NN_ReturnCode [HMS_LLMEngineContext_GetAllTokenGenerationLen](#hms_llmenginecontext_getalltokengenerationlen) (const [HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, uint32_t *len)|获取所有已生成tokenid的长度。|
|OH_NN_ReturnCode [HMS_LLMEngineContext_GetAllTokenGeneration](#hms_llmenginecontext_getalltokengeneration) (const [HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, int32_t *genToken, uint32_t len)|获取所有已生成的tokenid。|
|OH_NN_ReturnCode [HMS_LLMEngineExecutor_Generate](#hms_llmengineexecutor_generate) ([HMS_LLMEngine_Executor](#hms_llmengine_executor) *executor, [HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, const [HMS_LLMEngine_Prompt](#hms_llmengine_prompt) *prompt)|执行同步LLM推理。|
|OH_NN_ReturnCode [HMS_LLMEngineExecutor_GenerateAsync](#hms_llmengineexecutor_generateasync) ([HMS_LLMEngine_Executor](#hms_llmengine_executor) *executor, [HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, const [HMS_LLMEngine_Prompt](#hms_llmengine_prompt) *prompt)|异步执行LLM推理。|
|OH_NN_ReturnCode [HMS_LLMEngineExecutor_SetInferencePerfMode](#hms_llmengineexecutor_setinferenceperfmode) ([HMS_LLMEngine_Executor](#hms_llmengine_executor) *executor, [HMS_LLMEngine_InferPerfMode](#hms_llmengine_inferperfmode) inferPerfMode)|设置推理性能模式。|
|OH_NN_ReturnCode [HMS_LLMEngineContext_GetTotalTimeMs](#hms_llmenginecontext_gettotaltimems) (const [HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, double *ms)|生成总耗时（单位：ms）。|
|OH_NN_ReturnCode [HMS_LLMEngineContext_GetPrefillTimeMs](#hms_llmenginecontext_getprefilltimems) (const [HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, double *ms)|预填充时间（单位：ms）。|
|OH_NN_ReturnCode [HMS_LLMEngineContext_GetDecodeTimeMs](#hms_llmenginecontext_getdecodetimems) (const [HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, double *ms)|解码耗时（单位：ms）。|
|OH_NN_ReturnCode [HMS_LLMEngineContext_GetInputTokenCount](#hms_llmenginecontext_getinputtokencount) (const [HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, uint64_t *count)|输入token数量。|
|OH_NN_ReturnCode [HMS_LLMEngineContext_GetOutputTokenCount](#hms_llmenginecontext_getoutputtokencount) (const [HMS_LLMEngine_Context](#hms_llmengine_context) *ctx, uint64_t *count)|输出token数量。|

## 类型定义说明

> phone | 2in1 | tablet | tv

### callbackFunctionType

> 2in1 6.1.1(24)+

```cpp
typedef void(* callbackFunctionType) (const HMS_LLMEngine_Context *)
```

**描述**

生成回调函数。

**起始版本：** 6.1.1(24)

### HiAI_AippParam

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
typedef struct HiAI_AippParam HiAI_AippParam
```

**描述**

AIPP参数对象。

**起始版本：** 4.1.0(11)

### HiAI_SingleOpBuffer

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
typedef struct HiAI_SingleOpBuffer HiAI_SingleOpBuffer
```

**描述**

单算子Buffer句柄。

**起始版本：** 5.0.0(12)

### HiAI_SingleOpDescriptor

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
typedef struct HiAI_SingleOpDescriptor HiAI_SingleOpDescriptor
```

**描述**

单算子的算子描述句柄。

**起始版本：** 5.0.0(12)

### HiAISingleOpDescriptor_ConvolutionParam

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
typedef struct HiAISingleOpDescriptor_ConvolutionParam HiAISingleOpDescriptor_ConvolutionParam
```

**描述**

[HMS_HiAISingleOpDescriptor_CreateConvolution](#hms_hiaisingleopdescriptor_createconvolution)输入参数。

**起始版本：** 5.0.0(12)

### HiAI_SingleOpExecutor

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
typedef struct HiAI_SingleOpExecutor HiAI_SingleOpExecutor
```

**描述**

单算子执行器句柄。

**起始版本：** 5.0.0(12)

### HiAI_SingleOpExecutorConvolutionParam

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
typedef struct HiAI_SingleOpExecutorConvolutionParam HiAI_SingleOpExecutorConvolutionParam
```

**描述**

[HMS_HiAISingleOpExecutor_CreateConvolution](#hms_hiaisingleopexecutor_createconvolution)输入参数。

**起始版本：** 5.0.0(12)

### HiAI_SingleOpExecutorFusedConvolutionActivationParam

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
typedef struct HiAI_SingleOpExecutorFusedConvolutionActivationParam HiAI_SingleOpExecutorFusedConvolutionActivationParam
```

**描述**

[HMS_HiAISingleOpExecutor_CreateFusedConvolutionActivation](#hms_hiaisingleopexecutor_createfusedconvolutionactivation)输入参数。

**起始版本：** 5.0.0(12)

### HiAI_SingleOpOptions

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
typedef struct HiAI_SingleOpOptions HiAI_SingleOpOptions
```

**描述**

单算子选项句柄。

**起始版本：** 5.0.0(12)

### HiAI_SingleOpTensor

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
typedef struct HiAI_SingleOpTensor HiAI_SingleOpTensor
```

**描述**

单算子Tensor句柄。

**起始版本：** 5.0.0(12)

### HiAI_SingleOpTensorDesc

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
typedef struct HiAI_SingleOpTensorDesc HiAI_SingleOpTensorDesc
```

**描述**

单算子Tensor描述的句柄。

**起始版本：** 5.0.0(12)

### HMS_LLMEngine_Context

> 2in1 6.1.1(24)+

```cpp
typedef struct HMS_LLMEngine_Context HMS_LLMEngine_Context
```

**描述**

定义LLM引擎上下文的别名。

**起始版本：** 6.1.1(24)

### HMS_LLMEngine_Executor

> 2in1 6.1.1(24)+

```cpp
typedef struct HMS_LLMEngine_Executor HMS_LLMEngine_Executor
```

**描述**

LLM引擎执行器。

**起始版本：** 6.1.1(24)

### HMS_LLMEngine_Prompt

> 2in1 6.1.1(24)+

```cpp
typedef struct HMS_LLMEngine_Prompt HMS_LLMEngine_Prompt
```

**描述**

LLM引擎文本输入。

**起始版本：** 6.1.1(24)

## 枚举类型说明

> phone | 2in1 | tablet | tv

### HiAI_BandMode

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_BandMode
```

**描述**

定义硬件之间带宽模式。

**起始版本：** 4.1.0(11)

|枚举值|描述|
|:-------------------|:---------|
|HIAI_BANDMODE_UNSET|不设置，由系统调节。|
|HIAI_BANDMODE_LOW|低级带宽模式。|
|HIAI_BANDMODE_NORMAL|中级带宽模式。|
|HIAI_BANDMODE_HIGH|高级带宽模式。|

### HiAI_Compatibility

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_Compatibility
```

**描述**

编译后模型兼容性结果。

**起始版本：** 4.1.0(11)

|枚举值|描述|
|:------------------------------|:-----|
|HIAI_COMPATIBILITY_COMPATIBLE|模型兼容。|
|HIAI_COMPATIBILITY_INCOMPATIBLE|模型不兼容。|

### HiAI_DeviceMemoryReusePlan

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_DeviceMemoryReusePlan
```

**描述**

设备内存复用配置选项。

**起始版本：** 4.1.0(11)

|枚举值|描述|
|:----------------------------------|:---------------------------|
|HIAI_DEVICE_MEMORY_REUSE_PLAN_UNSET|不使用，默认值。|
|HIAI_DEVICE_MEMORY_REUSE_PLAN_LOW|低内存复用率，模型申请的内存较多但模型推理性能相对较优。|
|HIAI_DEVICE_MEMORY_REUSE_PLAN_HIGH|高内存复用率，模型申请的内存较少但模型推理性能相对较差。|

### HiAI_DynamicShapeCacheMode

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_DynamicShapeCacheMode
```

**描述**

编译前可变shape支持的模式。

**起始版本：** 4.1.0(11)

|枚举值|描述|
|:------------------------------------|:-------------------|
|HIAI_DYNAMIC_SHAPE_CACHE_BUILT_MODEL|缓存编译后的模型，内存占用较小，默认值。|
|HIAI_DYNAMIC_SHAPE_CACHE_LOADED_MODEL|缓存加载后的模型，性能较优。|

### HiAI_DynamicShapeStatus

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_DynamicShapeStatus
```

**描述**

是否使能编译前可变shape。

**起始版本：** 4.1.0(11)

|枚举值|描述|
|:--------------------------|:-----------------|
|HIAI_DYNAMIC_SHAPE_DISABLED|不使能编译前可变shape，默认值。|
|HIAI_DYNAMIC_SHAPE_ENABLED|使能编译前可变shape。|

### HiAI_ExecuteDevice

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_ExecuteDevice
```

**描述**

模型运行时支持的设备类型。

**起始版本：** 4.1.0(11)

|枚举值|描述|
|:----------------------|:-------|
|HIAI_EXECUTE_DEVICE_NPU|NPU，默认值。|
|HIAI_EXECUTE_DEVICE_CPU|CPU。|
|HIAI_EXECUTE_DEVICE_GPU|GPU。|

### HiAI_FallbackMode

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_FallbackMode
```

**描述**

指定的硬件设备无法编译模型时，是否允许CANN Kit选择其他硬件设备，例如CPU。

**起始版本：** 4.1.0(11)

|枚举值|描述|
|:---------------------|:------|
|HIAI_FALLBACK_ENABLED|允许，默认值。|
|HIAI_FALLBACK_DISABLED|不允许。|

### HiAI_FormatMode

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_FormatMode
```

**描述**

模型编译时数据的排列格式。

**起始版本：** 4.1.0(11)

|枚举值|描述|
|:----------------------|:-----------|
|HIAI_FORMAT_MODE_NCHW|格式为NCHW，默认值。|
|HIAI_FORMAT_MODE_ORIGIN|格式为原始模型格式。|

### HiAI_ImageColorSpace

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_ImageColorSpace
```

**描述**

图像色域空间类型。

**起始版本：** 4.1.0(11)

|枚举值|描述|
|:-----------------------------|:------------------------|
|HIAI_JPEG|JPEG色域空间类型。|
|HIAI_BT_601_NARROW|BT.601 video range色域空间类型。|
|HIAI_BT_601_FULL|BT.601 full range色域空间类型。|
|HIAI_BT_709_NARROW|BT.709 video range色域空间类型。|
|HIAI_IMAGE_COLOR_SPACE_INVALID|无效图像色域类型。|

### HiAI_ImageFormat

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_ImageFormat
```

**描述**

CANN Kit推理支持的输入和输出Tensor的图片格式的枚举。

**起始版本：** 4.1.0(11)

|枚举值|描述|
|:------------------------|:----------------|
|HIAI_YUV420SP_U8|YUV420SP_U8格式的图片。|
|HIAI_XRGB8888_U8|XRGB8888_U8格式的图片。|
|HIAI_YUV400_U8|YUV400_U8格式的图片。|
|HIAI_ARGB8888_U8|ARGB8888_U8格式的图片。|
|HIAI_YUYV_U8|YUYV_U8格式的图片。|
|HIAI_YUV422SP_U8|YUV422SP_U8格式的图片。|
|HIAI_AYUV444_U8|AYUV444_U8格式的图片。|
|HIAI_RGB888_U8|RGB888_U8格式的图片。|
|HIAI_BGR888_U8|BGR888_U8格式的图片。|
|HIAI_YUV444SP_U8|YUV444SP格式的图片。|
|HIAI_YVU444SP_U8|YVU444SP格式的图片。|
|HIAI_IMAGE_FORMAT_INVALID|不支持的图片格式。|

### HiAI_OmType

> phone 5.1.0(18)+ | 2in1 5.1.0(18)+ | tablet 5.1.0(18)+ | tv 5.1.1(19)+

```cpp
enum HiAI_OmType
```

**描述**

维测类型定义。

**起始版本：** 5.1.0(18)

|枚举值|描述|
|:---------------------|:---------------------------|
|HIAI_OM_TYPE_OFF|关闭维测。|
|HIAI_OM_TYPE_PROFILING|Profiling维测类型。|
|HIAI_OM_TYPE_DUMP|Dump维测类型。 **起始版本**：6.0.0(20)|

### HiAI_SingleOpActivationType

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_SingleOpActivationType
```

**描述**

单算子激活模式枚举。

**起始版本：** 5.0.0(12)

|枚举值|描述|
|:----------------------------------|:---------|
|HIAI_SINGLEOP_ACTIVATION_TYPE_RELU|ReLU激活函数。|
|HIAI_SINGLEOP_ACTIVATION_TYPE_RELU6|ReLU6激活函数。|

### HiAI_SingleOpConvMode

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_SingleOpConvMode
```

**描述**

单算子卷积模式枚举。

**起始版本：** 5.0.0(12)

|枚举值|描述|
|:---------------------------------|:----|
|HIAI_SINGLEOP_CONV_MODE_COMMON|普通卷积。|
|HIAI_SINGLEOP_CONV_MODE_TRANSPOSED|转置卷积。|
|HIAI_SINGLEOP_CONV_MODE_DEPTHWISE|深度卷积。|

### HiAI_SingleOpDataType

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_SingleOpDataType
```

**描述**

单算子张量数据类型枚举。

**起始版本：** 5.0.0(12)

|枚举值|描述|
|:-------------------------|:--------------|
|HIAI_SINGLEOP_DT_FLOAT|张量数据类型为float。|
|HIAI_SINGLEOP_DT_FLOAT16|张量数据类型为float16。|
|HIAI_SINGLEOP_DT_UNDEFINED|张量数据类型未定义。|

### HiAI_SingleOpFormat

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_SingleOpFormat
```

**描述**

单算子张量排布格式枚举。

**起始版本：** 5.0.0(12)

|枚举值|描述|
|:----------------------------|:-----------------------------------|
|HIAI_SINGLEOP_FORMAT_NCHW|张量按照NCHW格式排布。|
|HIAI_SINGLEOP_FORMAT_NHWC|张量按照NHWC格式排布。|
|HIAI_SINGLEOP_FORMAT_ND|张量按照ND格式排布。暂不支持用户使用ND格式排布的单算子Tensor。|
|HIAI_SINGLEOP_FORMAT_NC1HWC0|张量按照NC1HWC0格式排布。|
|HIAI_SINGLEOP_FORMAT_NC4HW4|张量按照NC4HW4格式排布。|
|HIAI_SINGLEOP_FORMAT_NC8HW8|张量按照NC8HW8格式排布。|
|HIAI_SINGLEOP_FORMAT_RESERVED|张量排布格式未定义。|

### HiAI_SingleOpPadMode

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_SingleOpPadMode
```

**描述**

单算子填充模式枚举。

**起始版本：** 5.0.0(12)

|枚举值|描述|
|:--------------------------------|:---------------------------------------------|
|HIAI_SINGLEOP_PAD_MODE_SPECIFIC|如果填充算法未设置，将根据参数**pads**采用显示填充。|
|HIAI_SINGLEOP_PAD_MODE_SAME|对输入进行填充使输出维度与输入维度相同。输出维度由ceil(输入维度 / 步长)确定。|
|HIAI_SINGLEOP_PAD_MODE_SAME_UPPER|使用SAME_UPPER填充模式，当填充长度为奇数时，起始的填充长度小于等于末尾的填充长度。|
|HIAI_SINGLEOP_PAD_MODE_SAME_LOWER|使用SAME_LOWER填充模式，当填充长度为奇数时，起始的填充长度大于等于末尾的填充长度。|
|HIAI_SINGLEOP_PAD_MODE_VALID|不填充，输出维度由ceil((输入维度 - 滤波器维度 + 1) / 步长)确定。|

### HiAI_SingleOpSupportStatus

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_SingleOpSupportStatus
```

**描述**

单算子支持状态枚举。

**起始版本：** 5.0.0(12)

|枚举值|描述|
|:------------------------|:---------------------------------|
|HIAI_SINGLEOP_OPTIMIZED|使用单算子性能已优化。推荐用户使用单算子执行器，执行单算子推理计算。|
|HIAI_SINGLEOP_COMMON|使用单算子性能普通。支持该算子，但使用单算子可能性能收益小。|
|HIAI_SINGLEOP_UNSUPPORTED|不支持该单算子。若创建该单算子执行器将会失败。|

### HiAI_TuningMode

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_TuningMode
```

**描述**

辅助调优模式。

**起始版本：** 4.1.0(11)

|枚举值|描述|
|:---------------------|:-----------------------|
|HIAI_TUNING_MODE_UNSET|关闭调优模式。|
|HIAI_TUNING_MODE_AUTO|自动调优模式，推荐选择的模式，内部算法控制调优。|
|HIAI_TUNING_MODE_HETER|异构调优模式。|

### HiAI_TuningStrategy

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
enum HiAI_TuningStrategy
```

**描述**

模型优化策略配置选项。

**起始版本：** 4.1.0(11)

|枚举值|描述|
|:-----------------------------------------------|:----------------------------|
|HIAI_TUNING_STRATEGY_OFF|不支持深度融合场景，也不支持编译前可变shape，默认值。|
|HIAI_TUNING_STRATEGY_ON_DEVICE_TUNING|支持编译前可变shape场景深度融合优化模型。|
|HIAI_TUNING_STRATEGY_ON_DEVICE_PREPROCESS_TUNING|NPU算子库动态升级场景深度融合优化模型。|
|HIAI_TUNING_STRATEGY_ON_CLOUD_TUNING|未来场景的预留，目前不使用。|

### HMS_LLMEngine_InferPerfMode

> 2in1 6.1.1(24)+

```cpp
enum HMS_LLMEngine_InferPerfMode
```

**描述**

推断性能模式。

**起始版本：** 6.1.1(24)

|枚举值|描述|
|:-----------------------------------|:-------------|
|HMS_LLMENGINE_INFERPERF_UNSET|推断perfmode未设置。|
|HMS_LLMENGINE_INFERPERF_LOW|低推理性能模式。|
|HMS_LLMENGINE_INFERPERF_MIDDLE|中度推理性能模式。|
|HMS_LLMENGINE_INFERPERF_HIGH|高推理性能模式。|
|HMS_LLMENGINE_INFERPERF_EXTREME_HIGH|极高推理性能模式。|

## 函数说明

> phone | 2in1 | tablet | tv

### HMS_HiAI_GetVersion()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
const char* HMS_HiAI_GetVersion (void)
```

**描述**

获取CANN Kit版本号，并通过返回模板hiaiversion A~1~A~2~A~3~.X~1~X~2~X~3~.Y~1~Y~2~Y~3~.Z~1~Z~2~Z~3~指定X~1~是否为0来区分是否支持NPU。若X~1~为0，则表示不支持NPU；若X~1~为非0，则表示支持NPU。

**起始版本：** 4.1.0(11)

**返回：**

成功返回CANN Kit版本号，失败返回空指针。

### HMS_HiAIAippParam_Create()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_AippParam* HMS_HiAIAippParam_Create (uint32_t batchNum)
```

**描述**

根据batchNum创建动态AippParam对象。

本方法用于创建动态AippParam对象，根据传入的batchNum申请相应的内存，用于存储动态AIPP参数。 不需要[HiAI_AippParam](#hiai_aippparam)指针实例时，需要调用[HMS_HiAIAippParam_Destroy](#hms_hiaiaippparam_destroy)进行释放，否则会出现内存泄漏。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-------|:--------------------------|
|batchNum|模型输入的batch大小，取值范围为(0, 127]。|

**返回：**

成功时返回[HiAI_AippParam](#hiai_aippparam)指针实例，失败返回空指针。

### HMS_HiAIAippParam_Destroy()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
void HMS_HiAIAippParam_Destroy (HiAI_AippParam ** aippParam)
```

**描述**

释放AippParam对象。

本方法用于释放通过[HMS_HiAIAippParam_Create](#hms_hiaiaippparam_create)创建的[HiAI_AippParam](#hiai_aippparam)对象。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:--------|:----------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空。|

### HMS_HiAIAippParam_GetBatchCount()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
uint32_t HMS_HiAIAippParam_GetBatchCount (HiAI_AippParam * aippParam)
```

**描述**

查询AippParam对象的图像数量。

本方法用于动态AIPP推理时，根据[HiAI_AippParam](#hiai_aippparam)对象查询推理AippParam设置图像数量。 在单batch多crop场景为一张图像多个crop的子图像的数量。在多batch单crop场景为输入的batch值。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:--------|:----------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空。|

**返回：**

成功返回图像数量，失败返回0。

### HMS_HiAIAippParam_GetChannelPadding()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_GetChannelPadding (HiAI_AippParam * aippParam, uint32_t batchIndex, uint32_t paddingValues[], uint32_t channelCount)
```

**描述**

查询AippParam对象的通道padding填充值。

本方法用于动态AIPP推理时，根据[HiAI_AippParam](#hiai_aippparam)对象查询对应索引的通道padding的填充值。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:--------------|:-----------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应crop出来的图像索引。|
|paddingValues[]|通道填充值数组，填充值范围[-65504, 65504]，默认填充值为0。|
|channelCount|通道填充数，当前支持[1, 4]，例如channelCount=3则对应查询通道chn0, chn1, chn2的数据。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_GetChannelSwapConfig()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_GetChannelSwapConfig (HiAI_AippParam * aippParam, bool * rbuvSwapSwitch, bool * axSwapSwitch)
```

**描述**

查询AippParam对象的ChannelSwap通道交换参数。

本方法用于动态AIPP推理时，根据[HiAI_AippParam](#hiai_aippparam)对象查询通道交换参数。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-------------|:-----------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|rbuvSwapSwitch|返回真为RB/UV通道交换已使能，返回假为RB/UV通道交换未使能。|
|axSwapSwitch|返回真为AX通道交换已使能，返回假为AX通道交换未使能。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_GetCropConfig()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_GetCropConfig (HiAI_AippParam * aippParam, uint32_t batchIndex, uint32_t * startPosW, uint32_t * startPosH, uint32_t * croppedW, uint32_t * croppedH)
```

**描述**

查询AippParam对象的裁剪参数。

本方法用于动态AIPP推理时，根据[HiAI_AippParam](#hiai_aippparam)对象查询对应索引的裁剪参数。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:---------|:---------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应即将crop出来的图像索引。|
|startPosW|裁剪起始位置水平方向坐标。|
|startPosH|裁剪起始位置垂直方向坐标。|
|croppedW|裁剪出的图像宽度，单位为px。|
|croppedH|裁剪出的图像高度，单位为px。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_GetCscConfig()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_GetCscConfig (HiAI_AippParam * aippParam, HiAI_ImageFormat * inputFormat, HiAI_ImageFormat * outputFormat, HiAI_ImageColorSpace * space)
```

**描述**

查询AippParam对象的CSC色域转换相关参数。

本方法用于动态AIPP推理时，根据[HiAI_AippParam](#hiai_aippparam)对象查询推理AippParam色域转换参数。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-----------|:---------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|inputFormat|图像输入格式，可参考[HiAI_ImageFormat](#hiai_imageformat)。|
|outputFormat|图像输出格式，可参考[HiAI_ImageFormat](#hiai_imageformat)。|
|space|图像颜色空间类型，可参考[HiAI_ImageColorSpace](#hiai_imagecolorspace)。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_GetData()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
void* HMS_HiAIAippParam_GetData (HiAI_AippParam * aippParam)
```

**描述**

获取AippParam申请的内存地址。

本方法用于获取通过[HMS_HiAIAippParam_Create](#hms_hiaiaippparam_create)申请的[HiAI_AippParam](#hiai_aippparam)的data内存地址。 data指向申请的AIPP参数的内存。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:--------|:-----------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返空指针。|

**返回：**

成功时返回AippParam申请的内存地址，失败返回空指针。

### HMS_HiAIAippParam_GetDataSize()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
uint32_t HMS_HiAIAippParam_GetDataSize (HiAI_AippParam * aippParam)
```

**描述**

获取AippParam申请的内存大小。

本方法用于获取通过[HMS_HiAIAippParam_Create](#hms_hiaiaippparam_create)申请的[HiAI_AippParam](#hiai_aippparam)的size大小。 size为申请的AIPP参数的内存大小。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:--------|:----------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回0。|

**返回：**

成功时返回AippParam申请的内存大小，失败返回0。

### HMS_HiAIAippParam_GetDtcMeanPixel()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_GetDtcMeanPixel (HiAI_AippParam * aippParam, uint32_t batchIndex, uint32_t meanPixel[], uint32_t channelCount)
```

**描述**

查询AippParam对象的数据类型转换通道像素平均值。

该方法用于动态AIPP推理时，根据[HiAI_AippParam](#hiai_aippparam)对象查询对应索引的数据类型转换像素平均值。 该方法需配合[HMS_HiAIAippParam_GetDtcMinPixel](#hms_hiaiaippparam_getdtcminpixel)、[HMS_HiAIAippParam_GetDtcVarReciPixel](#hms_hiaiaippparam_getdtcvarrecipixel)共同使用，来获取所有数据类型转换参数。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-----------|:----------------------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应crop出来的图像索引。|
|meanPixel[]|通道像素平均值数组，数组size为channelCount。|
|channelCount|通道数量，取值范围为[1, 4]，对应从chn0开始。例如channelCount等于3则对应查询通道chn0, chn1, chn2的数据。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_GetDtcMinPixel()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_GetDtcMinPixel (HiAI_AippParam * aippParam, uint32_t batchIndex, float minPixel[], uint32_t channelCount)
```

**描述**

查询AippParam对象的数据类型转换通道像素最小值。

该方法用于动态AIPP推理时，根据[HiAI_AippParam](#hiai_aippparam)对象查询对应索引的数据类型转换像素最小值。 该方法需配合[HMS_HiAIAippParam_GetDtcMeanPixel](#hms_hiaiaippparam_getdtcmeanpixel)、[HMS_HiAIAippParam_GetDtcVarReciPixel](#hms_hiaiaippparam_getdtcvarrecipixel)共同使用，来获取所有数据类型转换参数。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-----------|:----------------------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应crop出来的图像索引。|
|minPixel[]|通道像素最小值数组，数组size为channelCount。|
|channelCount|通道数量，取值范围为[1, 4]，对应从chn0开始。例如channelCount等于3则对应查询通道chn0, chn1, chn2的数据。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_GetDtcVarReciPixel()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_GetDtcVarReciPixel (HiAI_AippParam * aippParam, uint32_t batchIndex, float varReciPixel[], uint32_t channelCount)
```

**描述**

查询AippParam对象的数据类型转换通道像素方差。

该方法用于动态AIPP推理时，根据[HiAI_AippParam](#hiai_aippparam)对象查询对应索引的数据类型转换像素方差值。 该方法需配合[HMS_HiAIAippParam_GetDtcMeanPixel](#hms_hiaiaippparam_getdtcmeanpixel)、[HMS_HiAIAippParam_GetDtcMinPixel](#hms_hiaiaippparam_getdtcminpixel)共同使用，来获取所有数据类型转换参数。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-------------|:----------------------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应crop出来的图像索引。|
|varReciPixel[]|通道像素方差数组，数组size为channelCount。|
|channelCount|通道数量，取值范围为[1, 4]，对应从chn0开始。例如channelCount等于3则对应查询通道chn0, chn1, chn2的数据。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_GetInputAippIndex()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
int HMS_HiAIAippParam_GetInputAippIndex (HiAI_AippParam * aippParam)
```

**描述**

查询AippParam对象在该输入的多个输出分支上的索引。

本方法用于在data节点有多个索引时，查询AippParam对象在data节点上的索引。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:--------|:-----------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回-1。|

**返回：**

成功时返回该AippParam对象在data节点上的索引，失败返回-1。

### HMS_HiAIAippParam_GetInputFormat()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_ImageFormat HMS_HiAIAippParam_GetInputFormat (HiAI_AippParam * aippParam)
```

**描述**

查询AippParam对象的输入图像格式。

本方法用于动态AIPP推理时，根据[HiAI_AippParam](#hiai_aippparam)对象查询输入图像格式。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:--------|:-------------------------------------------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回[HIAI_IMAGE_FORMAT_INVALID](#hiai_imageformat)。|

**返回：**

成功返回[HiAI_ImageFormat](#hiai_imageformat)，失败返回[HIAI_IMAGE_FORMAT_INVALID](#hiai_imageformat)。

### HMS_HiAIAippParam_GetInputIndex()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
int HMS_HiAIAippParam_GetInputIndex (HiAI_AippParam * aippParam)
```

**描述**

查询AippParam对象所在输入的索引。

本方法用于在多个输入情况下，查询AippParam对象所在输入的索引。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:--------|:-----------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回-1。|

**返回：**

成功时返回该AippParam对象所在输入的索引，失败返回-1。

### HMS_HiAIAippParam_GetInputShape()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_GetInputShape (HiAI_AippParam * aippParam, uint32_t * srcImageW, uint32_t * srcImageH)
```

**描述**

查询AippParam对象的输入图像宽高。

本方法用于动态AIPP推理时，根据[HiAI_AippParam](#hiai_aippparam)对象查询输入图像宽高。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:--------|:-----------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|srcImageW|输入图像的宽度，单位为px。|
|srcImageH|输入图像的高度，单位为px。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_GetPadConfig()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_GetPadConfig (HiAI_AippParam * aippParam, uint32_t batchIndex, uint32_t * leftPadSize, uint32_t * rightPadSize, uint32_t * topPadSize, uint32_t * bottomPadSize)
```

**描述**

查询AippParam对象的输入图像的填充像素数。

本方法用于动态AIPP推理时，根据[HiAI_AippParam](#hiai_aippparam)对象查询对应索引的对输入图像的填充像素数。 当需要查询channel上的填充值时，需与[HMS_HiAIAippParam_GetChannelPadding](#hms_hiaiaippparam_getchannelpadding)一起使用。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:------------|:-------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应crop出来的图像索引。|
|leftPadSize|图像左侧Padding像素数。|
|rightPadSize|图像右侧Padding像素数。|
|topPadSize|图像上侧Padding像素数。|
|bottomPadSize|图像下侧Padding像素数。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_GetResizeConfig()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_GetResizeConfig (HiAI_AippParam * aippParam, uint32_t batchIndex, uint32_t * resizedW, uint32_t * resizedH)
```

**描述**

查询AippParam对象的图像缩放参数。

本方法用于动态AIPP推理时，根据[HiAI_AippParam](#hiai_aippparam)对象查询对应索引的缩放后图像宽高值。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:---------|:-------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应crop出来的图像索引。|
|resizedW|缩放后图像宽度，单位为px。|
|resizedH|缩放后图像高度，单位为px。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_GetRotationAngle()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_GetRotationAngle (HiAI_AippParam * aippParam, uint32_t batchIndex, float * rotationAngle)
```

**描述**

查询AippParam对象的图像旋转角度。

本方法用于动态AIPP推理时，根据[HiAI_AippParam](#hiai_aippparam)对象查询对应索引的图像旋转角度。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:------------|:-------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应crop出来的图像索引。|
|rotationAngle|旋转角度。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_GetSingleBatchMultiCrop()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
bool HMS_HiAIAippParam_GetSingleBatchMultiCrop (HiAI_AippParam * aippParam)
```

**描述**

查询AippParam对象的SingleBatchMultiCrop标识。

本方法用于动态AIPP推理时，根据[HiAI_AippParam](#hiai_aippparam)对象查询是否为单batch多crop场景。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:--------|:----------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空。|

**返回：**

返回true为单batch多crop场景，返回false为非单batch多crop场景。

### HMS_HiAIAippParam_SetChannelPadding()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_SetChannelPadding (HiAI_AippParam * aippParam, uint32_t batchIndex, uint32_t paddingValues[], uint32_t channelCount)
```

**描述**

设置AippParam对象的通道padding填充值。

本方法用于动态AIPP推理时，设置AIPP通道padding的填充值到[HiAI_AippParam](#hiai_aippparam)对象。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:--------------|:-----------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应crop出来的图像索引。|
|paddingValues[]|通道填充值数组，填充值范围[-65504, 65504]，默认填充值为0。|
|channelCount|通道填充数，当前支持[1, 4]，例如channelCount=3则对应配置通道chn0, chn1, chn2的数据。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_SetChannelSwapConfig()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_SetChannelSwapConfig (HiAI_AippParam * aippParam, bool rbuvSwapSwitch, bool axSwapSwitch)
```

**描述**

设置AippParam对象的ChannelSwap通道交换参数。

本方法用于动态AIPP推理时，设置AippParam通道交换参数到[HiAI_AippParam](#hiai_aippparam)对象。 AIPP支持两种类型的通道交换：RB/UV通道交换和AX通道交换。 RB/UV通道交换丰富了输入图像的格式，开启RB/UV通道交换后，AIPP支持的图像输入格式比可配置的输入类型丰富了一倍。

|配置类型|可接受图像类型|
|:----------|:---------------------------------------|
|YUV420SP_U8|YUV420SP_U8，YVU420 + rbuv_swap_switch|
|XRGB8888_U8|XRGB8888_U8，XBGR + rbuv_swap_switch|
|ARGB8888_U8|ARGB8888_U8，ABGR + rbuv_swap_switch|
|RGB888_U8|BGR888_U8 + rbuv_swap_switch|
|BGR888_U8|RGB888_U8 + rbuv_swap_switch|
|YUYV_U8|YUYV_U8，YVYU_U8 + rbuv_swap_switch|
|YUV422SP_U8|YUV422SP_U8，YVU422_U8 + rbuv_swap_switch|
|AYUV444_U8|AYUV444_U8 + rbuv_swap_switch|

YUV400_U8是灰度图，不支持通道交换。

当配置的图像输入格式为XRGB、ARGB或AYUV时，支持开启AX通道交换。开启后，图像第一个通道的输入被搬移到第四个通道上，即当XRGB、ARGB和AYUV开启AX通道交换后，转变为RGBX、RGBA和YUVA。 当模型训练集为RGB格式的图像，而推理时的图像输入为XRGB或者ARGB时，可以通过使能AX通道交换，将RGB通道前移，实现兼容。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-------------|:-----------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|rbuvSwapSwitch|参数真为使能RB/UV通道交换，参数假为不使能RB/UV通道交换。|
|axSwapSwitch|参数真为使能AX通道交换，参数假为不使能AX通道交换。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_SetCropConfig()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_SetCropConfig (HiAI_AippParam * aippParam, uint32_t batchIndex, uint32_t startPosW, uint32_t startPosH, uint32_t croppedW, uint32_t croppedH)
```

**描述**

设置AippParam对象的裁剪参数。

本方法用于动态AIPP推理时，设置裁剪参数到[HiAI_AippParam](#hiai_aippparam)对象。 YUV类型的图像受图像自身类型的限制，当输入图像类型为YUV420SP、YUYV、YUV422SP和AYUV444时，裁剪的起始坐标和裁剪的宽高需为是偶数。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:---------|:---------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应即将crop出来的图像索引。|
|startPosW|裁剪起始位置水平方向坐标，startPosW小于输入图像的宽度，单位为px。|
|startPosH|裁剪起始位置垂直方向坐标，startPosH小于输入图像的高度，单位为px。|
|croppedW|裁剪出的图像宽度，startPosW与cropSizeW之和小于等于输入图像的宽度，单位为px。|
|croppedH|裁剪出的图像高度，startPosH与cropSizeH之和小于等于输入图像的高度，单位为px。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_SetCscConfig()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_SetCscConfig (HiAI_AippParam * aippParam, HiAI_ImageFormat inputFormat, HiAI_ImageFormat outputFormat, HiAI_ImageColorSpace space)
```

**描述**

设置AippParam对象的CSC色域转换参数。

本方法用于动态AIPP推理时，设置AippParam色域转换参数到[HiAI_AippParam](#hiai_aippparam)对象。色域转换（Color Space Conversion，以下简称CSC），特指在YUV和RGB两种图像格式之间进行转换。输入为YUV格式图像(YUV420SP_U8/YUYV_U8/YUV422SP_U8/AYUV444_U8)，模型训练集可为RGB888_U8、BGR888_U8、灰度图（YUV400_U8）。输入为RGB格式图像(XRGB8888_U8/ARGB8888_U8/RGB888_U8/BGR888_U8)，模型训练集可为YUV444SP_U8、YVU444SP_U8、灰度图（YUV400_U8）。不支持从YUV400到RGB或BGR的转换。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-----------|:---------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|inputFormat|图像输入格式，可参考[HiAI_ImageFormat](#hiai_imageformat)。|
|outputFormat|图像输出格式，可参考[HiAI_ImageFormat](#hiai_imageformat)。|
|space|图像颜色空间类型，可参考[HiAI_ImageColorSpace](#hiai_imagecolorspace)。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_SetDtcMeanPixel()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_SetDtcMeanPixel (HiAI_AippParam * aippParam, uint32_t batchIndex, uint32_t meanPixel[], uint32_t channelCount)
```

**描述**

设置AippParam对象的数据类型转换通道像素平均值。

数据类型转换（Data Type Conversion，简称DTC），用于将输入图像中像素值转换为模型训练时的数据类型。设置DTC参数，使得转换之后的数据在一个预期的范围，避免强制转换。 数据类型转化功能，将输入的图像数据类型通过转化公式转换为FP16类型送给后续模块计算，实际为依次执行减均值、减最小值和乘方差操作。

计算公式为：U8->FP16: pixelOutChn(i) = [pixelInChn(i)--meanChn(i)--minChn(i)] * varReciChn(i), i ∈ [0, 4) 其中：pixelOutChn(i)为DTC模块的每个通道的输出值，pixelInChn(i)为DTC模块的每个通道的输入值，meanChn(i)为用户输入的每个通道的均值， minChn(i)为用户输入的每个通道的最小值， varReciChn(i)为用户输入的每个通道的方差。

该方法用于动态AIPP推理时，设置DTC数据类型转换像素平均值到[HiAI_AippParam](#hiai_aippparam)对象。 该方法需配合[HMS_HiAIAippParam_SetDtcMinPixel](#hms_hiaiaippparam_setdtcminpixel)、[HMS_HiAIAippParam_SetDtcVarReciPixel](#hms_hiaiaippparam_setdtcvarrecipixel)共同使用。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-----------|:-----------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应crop出来的图像索引。|
|meanPixel[]|通道像素平均值数组，数组size为channelCount，默认值为0。|
|channelCount|通道数量，取值范围为[1, 4]，例如channelCount=3则对应配置通道chn0, chn1, chn2的数据。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_SetDtcMinPixel()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_SetDtcMinPixel (HiAI_AippParam * aippParam, uint32_t batchIndex, float minPixel[], uint32_t channelCount)
```

**描述**

设置AippParam对象的数据类型转换通道像素最小值。

该方法用于动态AIPP推理时，设置DTC数据类型转换像素最小值到[HiAI_AippParam](#hiai_aippparam)对象。 该方法需配合[HMS_HiAIAippParam_SetDtcMeanPixel](#hms_hiaiaippparam_setdtcmeanpixel)、[HMS_HiAIAippParam_SetDtcVarReciPixel](#hms_hiaiaippparam_setdtcvarrecipixel)共同使用。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-----------|:-----------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应crop出来的图像索引。|
|minPixel[]|通道像素最小值数组，数组size为channelCount，默认值为0。|
|channelCount|通道数量，取值范围为[1, 4]，例如channelCount=3则对应配置通道chn0, chn1, chn2的数据。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_SetDtcVarReciPixel()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_SetDtcVarReciPixel (HiAI_AippParam * aippParam, uint32_t batchIndex, float varReciPixel[], uint32_t channelCount)
```

**描述**

设置AippParam对象的数据类型转换通道像素方差。

该方法用于动态AIPP推理时，设置DTC数据类型转换像素方差到[HiAI_AippParam](#hiai_aippparam)对象。 该方法需配合[HMS_HiAIAippParam_SetDtcMeanPixel](#hms_hiaiaippparam_setdtcmeanpixel)、[HMS_HiAIAippParam_SetDtcMinPixel](#hms_hiaiaippparam_setdtcminpixel)共同使用。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-------------|:-----------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应crop出来的图像索引。|
|varReciPixel[]|通道像素方差数组，数组size为channelCount，默认值为1.0。|
|channelCount|通道数量，取值范围为[1, 4]，例如channelCount=3则对应配置通道chn0, chn1, chn2的数据。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_SetInputAippIndex()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_SetInputAippIndex (HiAI_AippParam * aippParam, uint32_t inputAippIndex)
```

**描述**

设置AippParam对象作用于该输入的多个输出分支上的索引。

本方法用于在data有多个输出分支时，设置AippParam对象作用域该输入的第几个输出分支。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-------------|:------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空。|
|inputAippIndex|用于标识AIPP配置参数在输入Data有多个输出分支时作用于第几个分支，从0开始计数。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_SetInputFormat()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_SetInputFormat (HiAI_AippParam * aippParam, HiAI_ImageFormat inputFormat)
```

**描述**

设置AippParam对象的输入图像格式。

本方法用于动态AIPP推理时，设置AIPP的输入图像格式到[HiAI_AippParam](#hiai_aippparam)对象。 AIPP可配置的图像格式为[HiAI_ImageFormat](#hiai_imageformat)所支持的范围。 图像像素点为Uint8类型，范围为0到255。当图像的输入为YUV类型时，无论是YUV420还是YUV422或者YUYV，AIPP自动将图像数据补齐为YUV444格式。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:-----------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|inputFormat|输入图像的格式[HiAI_ImageFormat](#hiai_imageformat)。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_SetInputIndex()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_SetInputIndex (HiAI_AippParam * aippParam, uint32_t inputIndex)
```

**描述**

设置AippParam在输入上的索引。

本方法用于在多个输入情况下，设置索引以确定该AippParam对象作用于第几个输入。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:---------|:----------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空。|
|inputIndex|用于标识此AIPP参数作用于模型的第几个输入，从0开始计数。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_SetInputShape()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_SetInputShape (HiAI_AippParam * aippParam, uint32_t srcImageW, uint32_t srcImageH)
```

**描述**

设置AippParam对象的输入图像宽高。

本方法用于动态AIPP推理时，设置输入图像宽高到[HiAI_AippParam](#hiai_aippparam)对象。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:--------|:-----------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|srcImageW|输入图像的宽度，单位为px，取值范围[16, 4096]。|
|srcImageH|输入图像的高度，单位为px，取值范围[16, 4096]。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_SetPadConfig()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_SetPadConfig (HiAI_AippParam * aippParam, uint32_t batchIndex, uint32_t leftPadSize, uint32_t rightPadSize, uint32_t topPadSize, uint32_t bottomPadSize)
```

**描述**

设置AippParam对象的输入图像的填充像素数。

本方法用于动态AIPP推理时，设置对输入图像的填充像素数到[HiAI_AippParam](#hiai_aippparam)对象。包含图像左右上下侧的Padding像素数。 当需要设置channel上的填充值时，需与[HMS_HiAIAippParam_SetChannelPadding](#hms_hiaiaippparam_setchannelpadding)一起使用。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:------------|:-------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应crop出来的图像索引。|
|leftPadSize|图像左侧Padding像素数，经过padding后的图像宽度，需与原始模型维度中宽度保持一致。|
|rightPadSize|图像右侧Padding像素数，经过padding后的图像宽度，需与原始模型维度中宽度保持一致。|
|topPadSize|图像上侧Padding像素数，经过padding后的图像高度，需与原始模型维度中高度保持一致。|
|bottomPadSize|图像下侧Padding像素数，经过padding后的图像高度，需与原始模型维度中高度保持一致。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_SetResizeConfig()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_SetResizeConfig (HiAI_AippParam * aippParam, uint32_t batchIndex, uint32_t resizedW, uint32_t resizedH)
```

**描述**

设置AippParam对象的图像缩放参数。

本方法用于动态AIPP推理时，设置图像缩放参数到[HiAI_AippParam](#hiai_aippparam)对象。Resize的类型为双线性插值。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:---------|:-------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应crop出来的图像索引。|
|resizedW|缩放后图像宽度，单位为px，取值范围[16, 448]，图像宽度缩放倍数的范围[1/16, 16]。|
|resizedH|缩放后图像高度，单位为px，取值范围[16, 4096]，图像高度缩放倍数的范围[1/16, 16]。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_SetRotationAngle()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_SetRotationAngle (HiAI_AippParam * aippParam, uint32_t batchIndex, float rotationAngle)
```

**描述**

设置AippParam对象的旋转角度。

本方法用于动态AIPP推理时，设置旋转角度到[HiAI_AippParam](#hiai_aippparam)对象。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:------------|:-------------------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|batchIndex|对于多batch单crop场景，对应输入的图像索引；对于单batch多crop场景，对应crop出来的图像索引。|
|rotationAngle|旋转角度，仅支持0, 90, 180, 270。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIAippParam_SetSingleBatchMultiCrop()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIAippParam_SetSingleBatchMultiCrop (HiAI_AippParam * aippParam, bool singleBatchMultiCrop)
```

**描述**

设置AippParam对象的SingleBatchMultiCrop标识。

本方法用于动态AIPP推理时，设置AippParam单batch多crop标识到[HiAI_AippParam](#hiai_aippparam)对象。 对于单个batch的图像输入的场景，支持一次性传入多组crop等AIPP参数，一次推理即能得到全部人脸等的关键点信息。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-------------------|:-----------------------------------------------|
|aippParam|[HiAI_AippParam](#hiai_aippparam)指针实例，非空，否则返回失败。|
|singleBatchMultiCrop|参数真为单batch多crop场景，参数假为非单batch多crop场景。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAICompatibility_CheckFromBuffer()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_Compatibility HMS_HiAICompatibility_CheckFromBuffer (const void * data, size_t size)
```

**描述**

查询编译后储存在内存中的模型的兼容性。 若发生不兼容情况，建议重新编译模型。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:---|:--------------------|
|data|编译后模型数据地址，非空，否则返回不兼容。|
|size|编译后模型数据大小，非空，否则返回不兼容。|

**返回：**

成功返回 [HiAI_Compatibility](#hiai_compatibility)，失败返回不兼容。

### HMS_HiAICompatibility_CheckFromFile()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_Compatibility HMS_HiAICompatibility_CheckFromFile (const char * file)
```

**描述**

查询编译后储存在文件中的模型的兼容性。 若发生不兼容情况，建议重新编译模型。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:---|:--------------------------------------|
|file|编译后模型文件路径及名称，要求用户进程对文件有访问权限，非空，否则返回不兼容。|

**返回：**

成功返回 [HiAI_Compatibility](#hiai_compatibility)，失败返回不兼容。

### HMS_HiAIOptions_GetBandMode()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_BandMode HMS_HiAIOptions_GetBandMode (const OH_NNCompilation * compilation)
```

**描述**

查询带宽模式。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回默认值。|

**返回：**

成功返回带宽模式[HiAI_BandMode](#hiai_bandmode)，失败返回默认值。

### HMS_HiAIOptions_GetDeviceMemoryReusePlan()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_DeviceMemoryReusePlan HMS_HiAIOptions_GetDeviceMemoryReusePlan (const OH_NNCompilation * compilation)
```

**描述**

查询调优配置中的设备内存复用参数。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回默认值。|

**返回：**

成功时返回[HiAI_DeviceMemoryReusePlan](#hiai_devicememoryreuseplan)，失败返回默认值。

### HMS_HiAIOptions_GetDynamicShapeCacheMode()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_DynamicShapeCacheMode HMS_HiAIOptions_GetDynamicShapeCacheMode (const OH_NNCompilation * compilation)
```

**描述**

查询编译前可变shape配置中的cacheMode参数。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回默认值。|

**返回：**

成功时返回[HiAI_DynamicShapeCacheMode](#hiai_dynamicshapecachemode)，失败返回默认值。

### HMS_HiAIOptions_GetDynamicShapeMaxCache()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
size_t HMS_HiAIOptions_GetDynamicShapeMaxCache (const OH_NNCompilation * compilation)
```

**描述**

查询编译前可变shape配置中的最大缓存数量。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:---------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回0。|

**返回：**

成功时返回最大缓存数量，失败返回0。

### HMS_HiAIOptions_GetDynamicShapeStatus()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_DynamicShapeStatus HMS_HiAIOptions_GetDynamicShapeStatus (const OH_NNCompilation * compilation)
```

**描述**

查询编译前可变shape配置中的状态参数。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回默认值。|

**返回：**

成功时返回[HiAI_DynamicShapeStatus](#hiai_dynamicshapestatus)，失败返回默认值。

### HMS_HiAIOptions_GetFallbackMode()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_FallbackMode HMS_HiAIOptions_GetFallbackMode (const OH_NNCompilation * compilation)
```

**描述**

查询调优配置中的回滚模式。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回默认值。|

**返回：**

成功时返回[HiAI_FallbackMode](#hiai_fallbackmode)，失败返回默认值。

### HMS_HiAIOptions_GetFormatMode()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_FormatMode HMS_HiAIOptions_GetFormatMode (const OH_NNCompilation * compilation)
```

**描述**

查询模型编译参数中的数据排列格式。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回默认值。|

**返回：**

成功返回[HiAI_FormatMode](#hiai_formatmode)，失败返回默认值。

### HMS_HiAIOptions_GetInputTensorShape()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
NN_TensorDesc* HMS_HiAIOptions_GetInputTensorShape (const OH_NNCompilation * compilation, size_t index)
```

**描述**

查询选项参数中指定索引的shape描述。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回空指针。|
|index|输入shape的索引，取值为[0, [HMS_HiAIOptions_GetInputTensorShapeSize](#hms_hiaioptions_getinputtensorshapesize))。|

**返回：**

成功返回选项参数中的shape描述，失败返回空指针。

### HMS_HiAIOptions_GetInputTensorShapeSize()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
size_t HMS_HiAIOptions_GetInputTensorShapeSize (const OH_NNCompilation * compilation)
```

**描述**

查询选项参数中shape描述的个数。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:---------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回0。|

**返回：**

成功返回选项参数中shape描述的个数，失败返回0。

### HMS_HiAIOptions_GetModelDeviceCount()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```CPP
size_t HMS_HiAIOptions_GetModelDeviceCount (const OH_NNCompilation * compilation)
```

**描述**

查询模型级调优配置中模型的执行设备个数。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:---------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回0。|

**返回：**

成功时返回执行设备的个数，失败返回0。

### HMS_HiAIOptions_GetModelDeviceOrder()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_ExecuteDevice* HMS_HiAIOptions_GetModelDeviceOrder (const OH_NNCompilation * compilation)
```

**描述**

查询模型级调优配置中模型的执行设备列表。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回空指针。|

**返回：**

成功时返回[HiAI_ExecuteDevice](#hiai_executedevice)执行设备列表，失败返回空指针。

### HMS_HiAIOptions_GetOperatorDeviceCount()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
size_t HMS_HiAIOptions_GetOperatorDeviceCount (const OH_NNCompilation * compilation, const char * operatorName)
```

**描述**

查询算子级调优配置中指定算子的执行设备个数。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回0。|
|operatorName|算子名称，非空，否则返回0。|

**返回：**

成功时返回执行设备的个数，失败返回0。

### HMS_HiAIOptions_GetOperatorDeviceOrder()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_ExecuteDevice* HMS_HiAIOptions_GetOperatorDeviceOrder (const OH_NNCompilation * compilation, const char * operatorName)
```

**描述**

查询算子级调优配置中指定算子的执行设备列表。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回空指针。|
|operatorName|算子名称，非空，否则返回空指针。|

**返回：**

成功时返回[HiAI_ExecuteDevice](#hiai_executedevice)执行设备列表，失败返回空指针。

### HMS_HiAIOptions_GetQuantConfigData()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
void* HMS_HiAIOptions_GetQuantConfigData (const OH_NNCompilation * compilation)
```

**描述**

查询量化配置的数据地址。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回空指针。|

**返回：**

成功返回量化配置的数据地址，失败返回空指针。

### HMS_HiAIOptions_GetQuantConfigSize()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
size_t HMS_HiAIOptions_GetQuantConfigSize (const OH_NNCompilation * compilation)
```

**描述**

查询量化配置的数据大小。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:---------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回0。|

**返回：**

成功返回量化配置的数据大小，失败返回0。

### HMS_HiAIOptions_GetTuningCacheDir()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
const char* HMS_HiAIOptions_GetTuningCacheDir (const OH_NNCompilation * compilation)
```

**描述**

查询辅助调优的缓存目录。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回空指针。|

**返回：**

成功返回缓存目录，失败返回空指针。

### HMS_HiAIOptions_GetTuningMode()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_TuningMode HMS_HiAIOptions_GetTuningMode (const OH_NNCompilation * compilation)
```

**描述**

查询辅助调优模式。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回默认值。|

**返回：**

返回辅助调优模式[HiAI_TuningMode](#hiai_tuningmode)，失败返回默认值。

### HMS_HiAIOptions_GetTuningStrategy()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_TuningStrategy HMS_HiAIOptions_GetTuningStrategy (const OH_NNCompilation * compilation)
```

**描述**

查询模型优化策略。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回默认值。|

**返回：**

成功返回[HiAI_TuningStrategy](#hiai_tuningstrategy)，失败返回默认值。

### HMS_HiAIOptions_SetBandMode()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIOptions_SetBandMode (OH_NNCompilation * compilation, HiAI_BandMode bandMode)
```

**描述**

设置NPU与周边硬件IO资源的带宽模式。

根据需要设置合适的值，带宽与功耗成正比，高带宽也意味着高功耗。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回失败。|
|bandMode|带宽模式[HiAI_BandMode](#hiai_bandmode)。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIOptions_SetDeviceMemoryReusePlan()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIOptions_SetDeviceMemoryReusePlan (OH_NNCompilation * compilation, HiAI_DeviceMemoryReusePlan deviceMemoryReusePlan)
```

**描述**

设置调优配置中的设备内存复用参数。

本方法仅在模型编译阶段生效。用于在调优时，指定设备内存复用方式。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:--------------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回失败。|
|deviceMemoryReusePlan|设备内存复用[HiAI_DeviceMemoryReusePlan](#hiai_devicememoryreuseplan)。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIOptions_SetDynamicShapeCacheMode()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIOptions_SetDynamicShapeCacheMode (OH_NNCompilation * compilation, HiAI_DynamicShapeCacheMode mode)
```

**描述**

设置编译前可变shape配置中的缓存模式参数。

本方法仅在模型编译阶段生效，用于在推理阶段期望变更shape，且模型的shape变化数量不超过10个场景。 本方法需与[HMS_HiAIOptions_SetDynamicShapeStatus](#hms_hiaioptions_setdynamicshapestatus)、[HMS_HiAIOptions_SetDynamicShapeMaxCache](#hms_hiaioptions_setdynamicshapemaxcache)搭配使用。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回失败。|
|mode|编译前可变shape的缓存模式[HiAI_DynamicShapeCacheMode](#hiai_dynamicshapecachemode)。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIOptions_SetDynamicShapeMaxCache()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIOptions_SetDynamicShapeMaxCache (OH_NNCompilation * compilation, size_t maxCacheCount)
```

**描述**

设置编译前可变shape配置中的最大缓存编译后模型数量。

本方法仅在模型编译阶段生效，用于在推理阶段期望变更shape，且模型的shape变化数量不超过10个场景。 本方法需与[HMS_HiAIOptions_SetDynamicShapeStatus](#hms_hiaioptions_setdynamicshapestatus)、[HMS_HiAIOptions_SetDynamicShapeCacheMode](#hms_hiaioptions_setdynamicshapecachemode)搭配使用。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回失败。|
|maxCacheCount|最大档位，取值范围[1, 10]。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIOptions_SetDynamicShapeStatus()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIOptions_SetDynamicShapeStatus (OH_NNCompilation * compilation, HiAI_DynamicShapeStatus status)
```

**描述**

设置编译前可变shape配置中的EnableMode参数。

本方法仅在模型编译阶段生效，用于在推理阶段期望变更shape，且模型的shape变化数量不超过10个场景。 本方法需与[HMS_HiAIOptions_SetDynamicShapeMaxCache](#hms_hiaioptions_setdynamicshapemaxcache)、[HMS_HiAIOptions_SetDynamicShapeCacheMode](#hms_hiaioptions_setdynamicshapecachemode)搭配使用。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回失败。|
|status|是否使能编译前可变shape[HiAI_DynamicShapeStatus](#hiai_dynamicshapestatus)。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIOptions_SetFallbackMode()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIOptions_SetFallbackMode (OH_NNCompilation * compilation, HiAI_FallbackMode fallbackMode)
```

**描述**

设置调优配置中的回滚模式。

本方法仅在模型编译阶段生效。用于在模型级或算子级调优时，指定的执行设备列表出现不支持时，是否可回滚到其他硬件执行。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回失败。|
|fallbackMode|是否使能回滚模式[HiAI_FallbackMode](#hiai_fallbackmode)。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIOptions_SetFormatMode()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIOptions_SetFormatMode (OH_NNCompilation * compilation, HiAI_FormatMode formatMode)
```

**描述**

设置模型编译时的数据排列格式。

本方法仅在模型编译阶段生效，用于模型中的数据排列格式与默认值不匹配时的场景。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:---------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空。|
|formatMode|数据排列格式[HiAI_FormatMode](#hiai_formatmode)。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIOptions_SetInputTensorShapes()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIOptions_SetInputTensorShapes (OH_NNCompilation * compilation, NN_TensorDesc * inputTensorDescs[], size_t shapeCount)
```

**描述**

编译时更新模型输入shape。

本方法仅在模型编译阶段生效，用于模型结构及权重不变，模型输入shape需要变化的场景。数组的大小需要与模型的输入数量保持一致。 模型编译后，模型的输入shape将变更为新设置的shape，推理时输入输出数据需符合新的模型输入输出描述。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-----------------|:------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空。|
|inputTensorDescs[]|模型输入shape列表数组[NN_TensorDesc](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-nn-tensordesc)，非空。|
|shapeCount|模型输入shape的个数，需与模型输入个数对应。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIOptions_SetModelDeviceOrder()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIOptions_SetModelDeviceOrder (OH_NNCompilation * compilation, HiAI_ExecuteDevice * executeDevices, size_t deviceCount)
```

**描述**

设置模型级调优配置中模型执行设备列表。

本方法仅在模型编译阶段生效，不可与其他调优混用。用于指定模型的执行设备列表，按照优先级顺序排列。默认NPU优先。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回失败。|
|executeDevices|支持的设备类型列表[HiAI_ExecuteDevice](#hiai_executedevice)，非空，否则返回失败。|
|deviceCount|支持的执行硬件个数。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIOptions_SetOmOptions()

> phone 5.1.0(18)+ | 2in1 5.1.0(18)+ | tablet 5.1.0(18)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIOptions_SetOmOptions (OH_NNCompilation * compilation, HiAI_OmType type, const char * outputDir)
```

**描述**

设置模型加载时的维测选项信息。

该方法属于可选接口，在模型加载阶段生效，用于模型的性能调试。

**起始版本：** 5.1.0(18)

**参数:**

|名称|描述|
|:----------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回失败。|
|type|维测类型[HiAI_OmType](#hiai_omtype)。|
|outputDir|维测输出目录，用于生产profiling相关文件。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIOptions_SetOperatorDeviceOrder()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIOptions_SetOperatorDeviceOrder (OH_NNCompilation * compilation, const char * operatorName, HiAI_ExecuteDevice * executeDevices, size_t deviceCount)
```

**描述**

设置算子级调优配置中算子执行设备列表。

本方法仅在模型编译阶段生效，不可与其他调优混用。用于指定模型中算子的执行设备列表，按照优先级顺序排列，算子名称不可重复。 模型中的算子可以部分指定，不指定的算子以NPU优先，可以使用开源工具Netron查看模型中的算子名称。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回失败。|
|operatorName|算子名称，非空，否则返回失败。|
|executeDevices|支持的设备类型列表[HiAI_ExecuteDevice](#hiai_executedevice)，非空，否则返回失败。|
|deviceCount|支持的执行硬件个数。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIOptions_SetQuantConfig()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIOptions_SetQuantConfig (OH_NNCompilation * compilation, void * data, size_t size)
```

**描述**

设置模型编译时量化配置。

本方法仅在模型编译阶段生效。用于模型编译时进行量化的场景。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回失败。|
|data|量化配置的数据地址，非空，否则返回失败。|
|size|量化配置的数据大小，大于0，否则返回失败。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIOptions_SetTuningCacheDir()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIOptions_SetTuningCacheDir (OH_NNCompilation * compilation, const char * cacheDir)
```

**描述**

设置辅助调优的缓存目录。

要求用户进程对缓存目录有读写权限。本方法需与[HMS_HiAIOptions_SetTuningMode](#hms_hiaioptions_settuningmode)搭配使用。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回失败。|
|cacheDir|缓存目录，非空，否则返回失败。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIOptions_SetTuningMode()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIOptions_SetTuningMode (OH_NNCompilation * compilation, HiAI_TuningMode tuningMode)
```

**描述**

选择辅助调优模式。

本方法仅在模型编译阶段生效，不可与其他调优混用。用于指定CANN Kit协助进行调优的场景。 本方法需与[HMS_HiAIOptions_SetTuningCacheDir](#hms_hiaioptions_settuningcachedir)搭配使用。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:----------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回失败。|
|tuningMode|辅助调优模式[HiAI_TuningMode](#hiai_tuningmode)。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAIOptions_SetTuningStrategy()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAIOptions_SetTuningStrategy (OH_NNCompilation * compilation, HiAI_TuningStrategy tuningStrategy)
```

**描述**

设置模型编译时的模型优化策略。

本方法仅在模型编译阶段生效。用于模型算子深度融合的场景。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|compilation|[OH_NNCompilation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-oh-nncompilation)指针实例，非空，否则返回失败。|
|tuningStrategy|模型优化策略配置[HiAI_TuningStrategy](#hiai_tuningstrategy)。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAISingleOpBuffer_Create()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpBuffer* HMS_HiAISingleOpBuffer_Create (size_t dataSize)
```

**描述**

按照指定的内存大小创建[HiAI_SingleOpBuffer](#hiai_singleopbuffer)对象。

本方法用于根据指定的**dataSize** 申请对应大小的ION内存，并创建[HiAI_SingleOpBuffer](#hiai_singleopbuffer)对象。当不再使用[HiAI_SingleOpBuffer](#hiai_singleopbuffer)对象时， 调用[HMS_HiAISingleOpBuffer_Destroy](#hms_hiaisingleopbuffer_destroy)销毁，否则会造成内存泄漏。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:-------|:-------------------------|
|dataSize|要申请的内存字节大小。该值不能为0，否则返回空指针。|

**返回：**

指向[HiAI_SingleOpBuffer](#hiai_singleopbuffer)对象的指针，如果创建失败则返回空指针。

### HMS_HiAISingleOpBuffer_Destroy()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAISingleOpBuffer_Destroy (HiAI_SingleOpBuffer ** buffer)
```

**描述**

释放[HiAI_SingleOpBuffer](#hiai_singleopbuffer)对象。

本方法用于释放调用[HMS_HiAISingleOpBuffer_Create](#hms_hiaisingleopbuffer_create)创建的[HiAI_SingleOpBuffer](#hiai_singleopbuffer)对象。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:-----|:-------------------------------------------------------------------------------------------|
|buffer|指向[HiAI_SingleOpBuffer](#hiai_singleopbuffer)对象的二级指针。**buffer** 和 ***buffer**不能是空指针，否则返回错误码。|

**返回：**

函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAISingleOpBuffer_GetData()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
void* HMS_HiAISingleOpBuffer_GetData (const HiAI_SingleOpBuffer * buffer)
```

**描述**

查询[HiAI_SingleOpBuffer](#hiai_singleopbuffer)的内存地址。

本方法用于获取指定[HiAI_SingleOpBuffer](#hiai_singleopbuffer)对象的内存地址。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:-----|:-------------------------------------------------------------------|
|buffer|指向[HiAI_SingleOpBuffer](#hiai_singleopbuffer)对象的指针。该值不能为空指针，否则返回空指针。|

**返回：**

Buffer的内存地址。

### HMS_HiAISingleOpBuffer_GetSize()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
size_t HMS_HiAISingleOpBuffer_GetSize (const HiAI_SingleOpBuffer * buffer)
```

**描述**

查询[HiAI_SingleOpBuffer](#hiai_singleopbuffer)的字节大小。

本方法用于获取指定[HiAI_SingleOpBuffer](#hiai_singleopbuffer)对象的字节大小。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:-----|:-----------------------------------------------------------------|
|buffer|指向[HiAI_SingleOpBuffer](#hiai_singleopbuffer)对象的指针。该值不能为空指针，否则返回0。|

**返回：**

Buffer的字节大小。

### HMS_HiAISingleOpDescriptor_CreateActivation()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpDescriptor* HMS_HiAISingleOpDescriptor_CreateActivation (HiAI_SingleOpActivationType activationType, float coef)
```

**描述**

创建激活函数类的描述符对象。

本方法用于根据传入的参数创建激活函数类的[HiAI_SingleOpDescriptor](#hiai_singleopdescriptor)对象。当不再使用[HiAI_SingleOpDescriptor](#hiai_singleopdescriptor)对象时，调用[HMS_HiAISingleOpDescriptor_Destroy](#hms_hiaisingleopdescriptor_destroy)销毁，否则会造成内存泄漏。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:-------------|:--------------------------------|
|activationType|激活模式。|
|coef|如果激活模式为带系数的激活类型，该值表示系数。否则，该值不会生效。|

**返回：**

指向[HiAI_SingleOpDescriptor](#hiai_singleopdescriptor)对象的指针，如果创建失败则返回空指针。

### HMS_HiAISingleOpDescriptor_CreateConvolution()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpDescriptor* HMS_HiAISingleOpDescriptor_CreateConvolution (HiAISingleOpDescriptor_ConvolutionParam param)
```

**描述**

创建卷积类（普通卷积、转置卷积、深度卷积）的描述符对象。

本方法用于根据传入的参数创建卷积类的[HiAI_SingleOpDescriptor](#hiai_singleopdescriptor)对象。当不再使用[HiAI_SingleOpDescriptor](#hiai_singleopdescriptor)对象时，调用[HMS_HiAISingleOpDescriptor_Destroy](#hms_hiaisingleopdescriptor_destroy)销毁，否则会造成内存泄漏。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:----|:----------------------------------------------------------------------------------------------------------------------------------------------|
|param|详细输入参数参见[HiAISingleOpDescriptor_ConvolutionParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopdesc-convparam)。|

**返回：**

指向[HiAI_SingleOpDescriptor](#hiai_singleopdescriptor)对象的指针，如果创建失败则返回空指针。

### HMS_HiAISingleOpDescriptor_Destroy()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
void HMS_HiAISingleOpDescriptor_Destroy (HiAI_SingleOpDescriptor ** opDesc)
```

**描述**

释放[HiAI_SingleOpDescriptor](#hiai_singleopdescriptor)对象。

当不再使用[HiAI_SingleOpDescriptor](#hiai_singleopdescriptor)对象时，调用该接口销毁，否则会造成内存泄漏。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:-----|:--------------------------------------------------------------------------------------------------|
|opDesc|指向[HiAI_SingleOpDescriptor](#hiai_singleopdescriptor)对象的二级指针。**opDesc** 和 ***opDesc**不能是空指针，否则销毁失败。|

### HMS_HiAISingleOpExecutor_CreateConvolution()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpExecutor* HMS_HiAISingleOpExecutor_CreateConvolution (HiAI_SingleOpExecutorConvolutionParam param)
```

**描述**

创建卷积类算子对应的[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象。

当不再使用[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象时，调用[HMS_HiAISingleOpExecutor_Destroy](#hms_hiaisingleopexecutor_destroy)销毁，否则会造成内存泄漏。

对于输出Tensor描述，其数据类型和排布格式可以同时为HIAI_SINGLEOP_DT_UNDEFINED和HIAI_SINGLEOP_FORMAT_RESERVED。在这种情况下，执行器会将输出的数据类型和排布格式设置为适配硬件的类型。该接口执行成功后，可以调用[HMS_HiAISingleOpExecutor_UpdateOutputTensorDesc](#hms_hiaisingleopexecutor_updateoutputtensordesc)更新输出Tensor描述的数据类型和排布格式。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:----|:--------------------------------------------------------------------------------------------------------------------------------------------|
|param|详细输入参数参见[HiAI_SingleOpExecutorConvolutionParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopexec-convparam)。|

**返回：**

指向[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象的指针，如果创建失败，则返回空指针。

### HMS_HiAISingleOpExecutor_CreateFusedConvolutionActivation()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpExecutor* HMS_HiAISingleOpExecutor_CreateFusedConvolutionActivation (HiAI_SingleOpExecutorFusedConvolutionActivationParam param)
```

**描述**

创建卷积和激活融合算子对应的[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象。

当不再使用[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象时，调用[HMS_HiAISingleOpExecutor_Destroy](#hms_hiaisingleopexecutor_destroy)销毁，否则会造成内存泄漏。

对于输出Tensor描述，其数据类型和排布格式可以为HIAI_SINGLEOP_DT_UNDEFINED和HIAI_SINGLEOP_FORMAT_RESERVED。在这种情况下，执行器会将输出的数据类型和排布格式设置为适配硬件的类型。该接口执行成功后，可以调用[HMS_HiAISingleOpExecutor_UpdateOutputTensorDesc](#hms_hiaisingleopexecutor_updateoutputtensordesc)更新输出Tensor描述的数据类型和排布格式。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:----|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|param|详细输入参数参见[HiAI_SingleOpExecutorFusedConvolutionActivationParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopexec-fusedconv-actparam)。|

**返回：**

指向[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象的指针，如果创建失败，则返回空指针。

### HMS_HiAISingleOpExecutor_Destroy()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAISingleOpExecutor_Destroy (HiAI_SingleOpExecutor ** executor)
```

**描述**

销毁[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象，释放执行器占用的内存。

当不再使用[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象时，调用该接口销毁，否则会造成内存泄漏。

注意：该接口不会释放传递给[HMS_HiAISingleOpExecutor_Init](#hms_hiaisingleopexecutor_init)的工作空间内存，工作空间所属的[HiAI_SingleOpBuffer](#hiai_singleopbuffer)需要单独释放。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:-------|:---------------------------------------------------------------------------------------------------|
|executor|指向[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象的二级指针。**executor** 和 ***executor**不能是空指针，否则返回错误码。|

**返回：**

函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAISingleOpExecutor_Execute()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAISingleOpExecutor_Execute (HiAI_SingleOpExecutor * executor, HiAI_SingleOpTensor * input[], int32_t inputNum, HiAI_SingleOpTensor * output[], int32_t outputNum)
```

**描述**

执行同步运算推理。

在调用该接口前，需要先通过[HMS_HiAISingleOpTensor_CreateFromTensorDesc](#hms_hiaisingleoptensor_createfromtensordesc)或[HMS_HiAISingleOpTensor_CreateFromSingleOpBuffer](#hms_hiaisingleoptensor_createfromsingleopbuffer)接口创建输入和输出Tensor并填充输入Tensor数据。执行器会通过执行推理产生推理结果，并将结果写入输出Tensor中。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:--------|:-----------------------------------------------------------------------|
|executor|指向[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象的指针。该值不能为空指针，否则返回错误码。|
|input[]|输入Tensor的数组。|
|inputNum|输入Tensor的数量。|
|output[]|输出Tensor的数组。|
|outputNum|输出Tensor的数量。|

**返回：**

函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAISingleOpExecutor_GetWorkspaceSize()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
size_t HMS_HiAISingleOpExecutor_GetWorkspaceSize (const HiAI_SingleOpExecutor * executor)
```

**描述**

查询[HiAI_SingleOpExecutor](#hiai_singleopexecutor)所需的ION内存工作空间的字节大小。

在成功创建[HiAI_SingleOpExecutor](#hiai_singleopexecutor)后，调用该接口获取执行器所需的ION内存工作空间的字节大小，然后需要调用[HMS_HiAISingleOpBuffer_Create](#hms_hiaisingleopbuffer_create)申请足够的工作空间内存，将分配的工作空间传入[HMS_HiAISingleOpExecutor_Init](#hms_hiaisingleopexecutor_init)接口。

注意：同一个执行器的工作空间内存和输入、输出Tensor内存不能复用，不同执行器的工作空间内存可以复用。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:-------|:---------------------------------------------------------------------|
|executor|指向[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象的指针。该值不能为空指针，否则返回0。|

**返回：**

工作空间的字节大小。

### HMS_HiAISingleOpExecutor_Init()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAISingleOpExecutor_Init (HiAI_SingleOpExecutor * executor, void * workspace, size_t workspaceSize)
```

**描述**

加载[HiAI_SingleOpExecutor](#hiai_singleopexecutor)。

在调用该接口之前，需要申请执行器所需的工作空间内存。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:------------|:------------------------------------------------------------------------------------------------------------------------------------------|
|executor|指向[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象的指针。该值不能为空指针，否则返回错误码。|
|workspace|工作空间地址。当**workspaceSize** 不为0时，该值必须为[HiAI_SingleOpBuffer](#hiai_singleopbuffer)中的内存地址，否则返回错误码。|
|workspaceSize|提供的**workspace** 的字节大小。该值必须大于等于[HMS_HiAISingleOpExecutor_GetWorkspaceSize](#hms_hiaisingleopexecutor_getworkspacesize)获取的所需工作空间大小， 否则返回错误码。|

**返回：**

函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAISingleOpExecutor_PreCheckConvolution()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpSupportStatus HMS_HiAISingleOpExecutor_PreCheckConvolution (HiAI_SingleOpExecutorConvolutionParam param)
```

**描述**

预查询卷积算子的支持状态。

根据该接口的返回值确定是否调用[HMS_HiAISingleOpExecutor_CreateConvolution](#hms_hiaisingleopexecutor_createconvolution)来创建卷积执行器，也可以不调用本方法，直接调用创建卷积执行器。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:----|:--------------------------------------------------------------------------------------------------------------------------------------------|
|param|详细输入参数参见[HiAI_SingleOpExecutorConvolutionParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopexec-convparam)。|

**返回：**

支持状态。具体状态请参考[HiAI_SingleOpSupportStatus](#hiai_singleopsupportstatus)。

### HMS_HiAISingleOpExecutor_PreCheckFusedConvolutionActivation()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpSupportStatus HMS_HiAISingleOpExecutor_PreCheckFusedConvolutionActivation (HiAI_SingleOpExecutorFusedConvolutionActivationParam param)
```

**描述**

预查询卷积和激活融合算子的支持状态。

根据该接口的返回值确定是否调用[HMS_HiAISingleOpExecutor_CreateFusedConvolutionActivation](#hms_hiaisingleopexecutor_createfusedconvolutionactivation)来创建卷积激活融合执行器，也可以不调用本方法，直接创建卷积激活融合执行器。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:----|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|param|详细输入参数参见[HiAI_SingleOpExecutorFusedConvolutionActivationParam](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/cannkit-sopexec-fusedconv-actparam)。|

**返回：**

支持状态。具体状态请参考[HiAI_SingleOpSupportStatus](#hiai_singleopsupportstatus)。

### HMS_HiAISingleOpExecutor_UpdateOutputTensorDesc()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAISingleOpExecutor_UpdateOutputTensorDesc (const HiAI_SingleOpExecutor * executor, uint32_t index, HiAI_SingleOpTensorDesc * output)
```

**描述**

更新[HiAI_SingleOpExecutor](#hiai_singleopexecutor)的输出tensor描述。

如果在创建[HiAI_SingleOpExecutor](#hiai_singleopexecutor)时，输入参数**output** 数据类型为HIAI_SINGLEOP_DT_UNDEFINED，且排布格式为HIAI_SINGLEOP_FORMAT_RESERVED，那么在成功创建[HiAI_SingleOpExecutor](#hiai_singleopexecutor)后，调用该接口将输出Tensor描述更新为硬件适配的数据类型和排布格式。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:-------|:-----------------------------------------------------------------------|
|executor|指向[HiAI_SingleOpExecutor](#hiai_singleopexecutor)对象的指针。该值不能为空指针，否则返回错误码。|
|index|输出Tensor描述的索引，与创建executor时的输出顺序一致。索引值从0开始。|
|output|需要更新的[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的指针。|

**返回：**

函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAISingleOpOptions_Create()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpOptions* HMS_HiAISingleOpOptions_Create (void)
```

**描述**

创建[HiAI_SingleOpOptions](#hiai_singleopoptions)对象。

当不再使用[HiAI_SingleOpOptions](#hiai_singleopoptions)对象时，调用[HMS_HiAISingleOpOptions_Destroy](#hms_hiaisingleopoptions_destroy)销毁，否则会造成内存泄漏。

**起始版本：** 5.0.0(12)

**返回：**

指向[HiAI_SingleOpOptions](#hiai_singleopoptions)对象的指针，如果创建失败则返回空指针。

### HMS_HiAISingleOpOptions_Destroy()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
void HMS_HiAISingleOpOptions_Destroy (HiAI_SingleOpOptions ** options)
```

**描述**

释放[HiAI_SingleOpOptions](#hiai_singleopoptions)对象。

本方法用于释放调用[HMS_HiAISingleOpOptions_Create](#hms_hiaisingleopoptions_create)创建的[HiAI_SingleOpOptions](#hiai_singleopoptions)对象。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:------|:----------------------------------------------------------------------------------------------|
|options|指向[HiAI_SingleOpOptions](#hiai_singleopoptions)对象的二级指针。**options** 和 ***options**不能是空指针，否则销毁失败。|

### HMS_HiAISingleOpTensor_CreateFromConst()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpTensor* HMS_HiAISingleOpTensor_CreateFromConst (const HiAI_SingleOpTensorDesc * desc, void * data, size_t dataSize)
```

**描述**

根据[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)、常量数据（如卷积权重、偏置等）的内存地址和数据大小创建[HiAI_SingleOpTensor](#hiai_singleoptensor)对象。

本方法用于根据[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)和常量数据（如卷积权重、偏置等）的内存地址和数据大小创建[HiAI_SingleOpTensor](#hiai_singleoptensor)对象。

本方法直接复用**data** 和**dataSize** 对应的常量数据，不会进行数据的拷贝。因此，在本方法创建的Tensor仍要被使用时，不要释放该Tensor对应的常量数据内存。本方法仅读取**data** 和**dataSize**对应的常量数据，不会修改其数据。

注意：该接口会将**desc** 拷贝到[HiAI_SingleOpTensor](#hiai_singleoptensor)中。因此，当**desc** 不再使用时，请使用[HMS_HiAISingleOpTensorDesc_Destroy](#hms_hiaisingleoptensordesc_destroy)销毁**desc**。

当不再使用[HiAI_SingleOpTensor](#hiai_singleoptensor)对象时，调用[HMS_HiAISingleOpTensor_Destroy](#hms_hiaisingleoptensor_destroy)销毁，否则会造成内存泄漏。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:-------|:---------------------------------------------------------------------------|
|desc|指向[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的指针。该值不能为空指针，否则返回空指针。|
|data|常量数据地址。该值不能为空指针，否则返回空指针。|
|dataSize|常量数据大小。该值不能为0，否则返回空指针。|

**返回：**

指向[HiAI_SingleOpTensor](#hiai_singleoptensor)对象的指针，如果创建失败则返回空指针。

### HMS_HiAISingleOpTensor_CreateFromSingleOpBuffer()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpTensor* HMS_HiAISingleOpTensor_CreateFromSingleOpBuffer (const HiAI_SingleOpTensorDesc * desc, void * data, size_t dataSize)
```

**描述**

根据[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)、[HiAI_SingleOpBuffer](#hiai_singleopbuffer)的内存地址和数据大小创建[HiAI_SingleOpTensor](#hiai_singleoptensor)对象。

本方法复用[HiAI_SingleOpBuffer](#hiai_singleopbuffer)的ION内存，所复用的内存地址和大小由**data** 和**dataSize** 确定。**dataSize** 必须等于通过[HMS_HiAISingleOpTensorDesc_GetByteSize](#hms_hiaisingleoptensordesc_getbytesize)计算得到的**desc** 的字节大小。当调用[HMS_HiAISingleOpTensor_Destroy](#hms_hiaisingleoptensor_destroy)接口销毁该接口创建的Tensor时，不会释放该Tensor数据的内存。

注意：该接口会将**desc** 拷贝到[HiAI_SingleOpTensor](#hiai_singleoptensor)中。因此，当**desc** 不再使用时，请使用[HMS_HiAISingleOpTensorDesc_Destroy](#hms_hiaisingleoptensordesc_destroy)销毁**desc**。

当不再使用[HiAI_SingleOpTensor](#hiai_singleoptensor)对象时，调用[HMS_HiAISingleOpTensor_Destroy](#hms_hiaisingleoptensor_destroy)销毁，否则会造成内存泄漏。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:-------|:---------------------------------------------------------------------------|
|desc|指向[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的指针。该值不能为空指针，否则返回空指针。|
|data|Tensor数据地址。该值必须是[HiAI_SingleOpBuffer](#hiai_singleopbuffer)中的内存地址，否则返回空指针。|
|dataSize|Tensor数据大小。该值不能为0，否则返回空指针。|

**返回：**

指向[HiAI_SingleOpTensor](#hiai_singleoptensor)对象的指针，如果创建失败则返回空指针。

### HMS_HiAISingleOpTensor_CreateFromTensorDesc()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpTensor* HMS_HiAISingleOpTensor_CreateFromTensorDesc (const HiAI_SingleOpTensorDesc * desc)
```

**描述**

根据[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)创建[HiAI_SingleOpTensor](#hiai_singleoptensor)对象。

本方法使用[HMS_HiAISingleOpTensorDesc_GetByteSize](#hms_hiaisingleoptensordesc_getbytesize)计算Tensor数据的字节数， 并使用[HMS_HiAISingleOpBuffer_Create](#hms_hiaisingleopbuffer_create)为Tensor数据分配ION内存。设备驱动将通过"零拷贝"的方式直接获取张量数据。

注意：该接口会将**desc** 拷贝到[HiAI_SingleOpTensor](#hiai_singleoptensor)中。因此，当**desc** 不再使用时，请使用[HMS_HiAISingleOpTensorDesc_Destroy](#hms_hiaisingleoptensordesc_destroy)销毁**desc**。

当不再使用[HiAI_SingleOpTensor](#hiai_singleoptensor)对象时，调用[HMS_HiAISingleOpTensor_Destroy](#hms_hiaisingleoptensor_destroy)销毁，否则会造成内存泄漏。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:---|:---------------------------------------------------------------------------|
|desc|指向[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的指针。该值不能为空指针，否则返回空指针。|

**返回：**

指向[HiAI_SingleOpTensor](#hiai_singleoptensor)对象的指针，如果创建失败则返回空指针。

### HMS_HiAISingleOpTensor_Destroy()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAISingleOpTensor_Destroy (HiAI_SingleOpTensor ** tensor)
```

**描述**

释放[HiAI_SingleOpTensor](#hiai_singleoptensor)对象。

当不再使用[HiAI_SingleOpTensor](#hiai_singleoptensor)对象时，需要调用该接口销毁该对象，否则会造成内存泄漏。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:-----|:-------------------------------------------------------------------------------------------|
|tensor|指向[HiAI_SingleOpTensor](#hiai_singleoptensor)对象的二级指针。**tensor** 和 ***tensor**不能是空指针，否则返回错误码。|

**返回：**

函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_HiAISingleOpTensor_GetBuffer()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpBuffer* HMS_HiAISingleOpTensor_GetBuffer (const HiAI_SingleOpTensor * tensor)
```

**描述**

获取[HiAI_SingleOpTensor](#hiai_singleoptensor)的Buffer。

本方法用于获取指定[HiAI_SingleOpTensor](#hiai_singleoptensor)对象的[HiAI_SingleOpBuffer](#hiai_singleopbuffer)。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:-----|:-------------------------------------------------------------------|
|tensor|指向[HiAI_SingleOpTensor](#hiai_singleoptensor)对象的指针。该值不能为空指针，否则返回空指针。|

**返回：**

指向[HiAI_SingleOpBuffer](#hiai_singleopbuffer)对象的指针。

### HMS_HiAISingleOpTensor_GetTensorDesc()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpTensorDesc* HMS_HiAISingleOpTensor_GetTensorDesc (const HiAI_SingleOpTensor * tensor)
```

**描述**

获取[HiAI_SingleOpTensor](#hiai_singleoptensor)的Tensor描述。

本方法用于获取指定[HiAI_SingleOpTensor](#hiai_singleoptensor)对象的[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:-----|:-------------------------------------------------------------------|
|tensor|指向[HiAI_SingleOpTensor](#hiai_singleoptensor)对象的指针。该值不能为空指针，否则返回空指针。|

**返回：**

指向[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的指针。

### HMS_HiAISingleOpTensorDesc_Create()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpTensorDesc* HMS_HiAISingleOpTensorDesc_Create (const int64_t * dims, size_t dimNum, HiAI_SingleOpDataType dataType, HiAI_SingleOpFormat format, bool isVirtual)
```

**描述**

创建[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象。

本方法用于根据传入的维度、数据类型、排布格式等参数创建[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象。

可以调用以下接口，基于传入的[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)指针创建[HiAI_SingleOpTensor](#hiai_singleoptensor)对象： [HMS_HiAISingleOpTensor_CreateFromTensorDesc](#hms_hiaisingleoptensor_createfromtensordesc)、[HMS_HiAISingleOpTensor_CreateFromSingleOpBuffer](#hms_hiaisingleoptensor_createfromsingleopbuffer)、 [HMS_HiAISingleOpTensor_CreateFromConst](#hms_hiaisingleoptensor_createfromconst)。

注意：这些接口会将[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象复制到[HiAI_SingleOpTensor](#hiai_singleoptensor)中。 当[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象不再使用时，调用[HMS_HiAISingleOpTensorDesc_Destroy](#hms_hiaisingleoptensordesc_destroy)接口销毁，否则会造成内存泄漏。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:--------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|dims|张量维度列表。该值不能为空指针，否则返回空指针。|
|dimNum|张量维度数量。该值不能为0，否则返回空指针。|
|dataType|张量数据类型。|
|format|张量排布格式。|
|isVirtual|表示张量是否是虚拟张量。true表示该张量为虚拟张量，false表示该张量为非虚拟张量。虚拟张量是相连的CANN Kit单算子之间的中间张量，其中的数据仅暂时存在，不经非CANN Kit单算子内存读取或写入。例如， 若CANN Kit单算子A的输出张量T1仅作为CANN Kit单算子B的输入张量，且用户只读取单算子B的输出张量T2，不会读取或写入T1，那么T1需要被设置为虚拟张量，而T2则是非虚拟张量。|

**返回：**

指向[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的指针，如果创建失败，则返回空指针。

### HMS_HiAISingleOpTensorDesc_Destroy()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
void HMS_HiAISingleOpTensorDesc_Destroy (HiAI_SingleOpTensorDesc ** tensorDesc)
```

**描述**

释放[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象。

本方法用于释放调用[HMS_HiAISingleOpTensorDesc_Create](#hms_hiaisingleoptensordesc_create)创建的[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:---------|:----------------------------------------------------------------------------------------------------|
|tensorDesc|指向[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的二级指针。 **tensorDesc** 和 ***tensorDesc**不能为空指针。|

### HMS_HiAISingleOpTensorDesc_GetByteSize()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
size_t HMS_HiAISingleOpTensorDesc_GetByteSize (const HiAI_SingleOpTensorDesc * tensorDesc)
```

**描述**

查询基于[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)的维度和数据类型计算的数据占用字节数。

本方法用于获取基于[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)的维度和数据类型计算得到的数据占用字节数。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:---------|:-------------------------------------------------------------------------|
|tensorDesc|指向[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的指针。该值不能为空指针，否则返回0。|

**返回：**

张量的数据字节数。

### HMS_HiAISingleOpTensorDesc_GetDataType()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpDataType HMS_HiAISingleOpTensorDesc_GetDataType (const HiAI_SingleOpTensorDesc * tensorDesc)
```

**描述**

查询[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)的数据类型。

本方法用于获取指定[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的数据类型。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:---------|:--------------------------------------------------------------------------------------------------|
|tensorDesc|指向[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的指针。该值不能为空指针，否则返回HIAI_SINGLEOP_DT_UNDEFINED。|

**返回：**

张量的数据类型。

### HMS_HiAISingleOpTensorDesc_GetDimension()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
int64_t HMS_HiAISingleOpTensorDesc_GetDimension (const HiAI_SingleOpTensorDesc * tensorDesc, size_t index)
```

**描述**

查询[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)指定索引的维度长度。

本方法用于获取指定[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的某个维度的长度。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:---------|:-------------------------------------------------------------------------|
|tensorDesc|指向[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的指针。该值不能为空指针，否则返回0。|
|index|维度的索引值。索引从0开始。|

**返回：**

张量的索引为**index**的维度的长度，如果执行失败，则返回0。

### HMS_HiAISingleOpTensorDesc_GetDimensionCount()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
size_t HMS_HiAISingleOpTensorDesc_GetDimensionCount (const HiAI_SingleOpTensorDesc * tensorDesc)
```

**描述**

查询[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)的维度数量。

本方法用于获取指定[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的维度数量。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:---------|:-------------------------------------------------------------------------|
|tensorDesc|指向[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的指针。该值不能为空指针，否则返回0。|

**返回：**

张量的维度数量，如果执行失败，则返回0。

### HMS_HiAISingleOpTensorDesc_GetFormat()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
HiAI_SingleOpFormat HMS_HiAISingleOpTensorDesc_GetFormat (const HiAI_SingleOpTensorDesc * tensorDesc)
```

**描述**

查询[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)的排布格式。

本方法用于获取指定[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的排布格式。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:---------|:-----------------------------------------------------------------------------------------------------|
|tensorDesc|指向[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的指针。该值不能为空指针，否则返回HIAI_SINGLEOP_FORMAT_RESERVED。|

**返回：**

张量的排布格式。

### HMS_HiAISingleOpTensorDesc_IsVirtual()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
bool HMS_HiAISingleOpTensorDesc_IsVirtual (const HiAI_SingleOpTensorDesc * tensorDesc)
```

**描述**

查询[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)是否为虚拟张量。

虚拟张量是相连的CANN Kit单算子之间的中间张量，其中的数据仅暂时存在，不经非CANN Kit单算子内存读取或写入。例如，若CANN Kit单算子A的输出张量T1仅作为CANN Kit单算子B的输入张量，且用户只读取单算子B的输出张量T2，不会读取或写入T1， 那么T1需要被设置为虚拟张量，而T2则是非虚拟张量。

**起始版本：** 5.0.0(12)

**参数:**

|名称|描述|
|:---------|:-----------------------------------------------------------------------------|
|tensorDesc|指向[HiAI_SingleOpTensorDesc](#hiai_singleoptensordesc)对象的指针。该值不能为空指针，否则返回false。|

**返回：**

如果张量是虚拟张量，则返回true，否则返回false。

### HMS_HiAITensor_GetSizeWithImageFormat()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
size_t HMS_HiAITensor_GetSizeWithImageFormat (NN_TensorDesc * desc, HiAI_ImageFormat format)
```

**描述**

根据NN_TensorDesc和HiAI_ImageFormat计算申请tensor的大小。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-----|:---------------------------------------------------------------------------------------------------------------------------------------|
|desc|[NN_TensorDesc](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-nn-tensordesc)指针实例，非空，否则返回0。|
|format|图像的格式[HiAI_ImageFormat](#hiai_imageformat)。|

**返回：**

成功时返回计算后需要申请的tensor的大小，失败返回0。

### HMS_HiAITensor_SetAippParams()

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+ | tv 5.1.1(19)+

```cpp
OH_NN_ReturnCode HMS_HiAITensor_SetAippParams (NN_Tensor * tensor, HiAI_AippParam * aippParams[], size_t aippNum)
```

**描述**

给NN_Tensor设置AippParams。

AIPP参数设置给NN_Tensor后，其内存在tensor使用完成后，调用[HMS_HiAIAippParam_Destroy](#hms_hiaiaippparam_destroy)释放。

**起始版本：** 4.1.0(11)

**参数:**

|名称|描述|
|:-----------|:---------------------------------------------------------------------------------------------------------------------------------|
|tensor|[NN_Tensor](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neuralnetworkruntime-nn-tensor)指针实例，非空，否则返回空指针。|
|aippParams[]|AIPP参数数组。|
|aippNum|AIPP参数数量。|

**返回：**

函数执行结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

### HMS_LLMEngine_Context_Destroy()

> 2in1 6.1.1(24)+

```cpp
void HMS_LLMEngine_Context_Destroy (HMS_LLMEngine_Context ** ctx)
```

**描述**

销毁LLM引擎上下文。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:--|:---------|
|ctx|待销毁的上下文句柄。|

### HMS_LLMEngineContext_CreateFromContextJson()

> 2in1 6.1.1(24)+

```cpp
HMS_LLMEngine_Context* HMS_LLMEngineContext_CreateFromContextJson (const char * jsonFile)
```

**描述**

通过JSON配置文件创建LLM引擎上下文句柄。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:-------|:----------------|
|jsonFile|JSON配置文件的路径，不能为空。|

**返回：**

创建的LLM引擎上下文句柄。

### HMS_LLMEngineContext_GetAllGeneration()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineContext_GetAllGeneration (const HMS_LLMEngine_Context * ctx, char * generation, uint32_t len )
```

**描述**

获取所有生成的文本。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:---------|:--------------------------------------------------------------|
|ctx|指向 [HMS_LLMEngine_Context](#hms_llmengine_context) 的指针，不能为null。|
|generation|指向所有生成文本的指针。|
|len|所有生成文本的长度。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空或len为0。|

### HMS_LLMEngineContext_GetAllGenerationLen()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineContext_GetAllGenerationLen (const HMS_LLMEngine_Context * ctx, uint32_t * len )
```

**描述**

获取所有生成文本的总长度。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:--|:--------------------------------------------------------------|
|ctx|指向 [HMS_LLMEngine_Context](#hms_llmengine_context) 的指针，不能为null。|
|len|所有生成文本的总长度。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空或len为0。|

### HMS_LLMEngineContext_GetAllTokenGeneration()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineContext_GetAllTokenGeneration (const HMS_LLMEngine_Context * ctx, int32_t * genToken, uint32_t len )
```

**描述**

获取所有已生成的tokenid。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:-------|:------------------------------------------------------------|
|ctx|指向[HMS_LLMEngine_Context](#hms_llmengine_context)的指针，不能为null。|
|genToken|指向生成的tokenid的指针。|
|len|所有已生成tokenid的长度。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空或len为0。|

### HMS_LLMEngineContext_GetAllTokenGenerationLen()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineContext_GetAllTokenGenerationLen (const HMS_LLMEngine_Context * ctx, uint32_t * len )
```

**描述**

获取所有已生成tokenid的长度。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:--|:------------------------------------------------------------|
|ctx|指向[HMS_LLMEngine_Context](#hms_llmengine_context)的指针，不能为null。|
|len|所有已生成tokenid的长度。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空或len为0。|

### HMS_LLMEngineContext_GetDecodeTimeMs()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineContext_GetDecodeTimeMs (const HMS_LLMEngine_Context * ctx, double * ms )
```

**描述**

解码耗时。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:--|:------------------------------------------------------------|
|ctx|指向[HMS_LLMEngine_Context](#hms_llmengine_context)的指针，不能为null。|
|ms|解码耗时（单位：ms）。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空。|

### HMS_LLMEngineContext_GetInputTokenCount()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineContext_GetInputTokenCount (const HMS_LLMEngine_Context * ctx, uint64_t * count )
```

**描述**

输入token数量。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:----|:------------------------------------------------------------|
|ctx|指向[HMS_LLMEngine_Context](#hms_llmengine_context)的指针，不能为null。|
|count|输入token数量。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空。|

### HMS_LLMEngineContext_GetOneGeneration()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineContext_GetOneGeneration (const HMS_LLMEngine_Context * ctx, char * generation, uint32_t len )
```

**描述**

获取生成的文本片段。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:---------|:------------------------------------------------------------|
|ctx|指向[HMS_LLMEngine_Context](#hms_llmengine_context)的指针，不能为null。|
|generation|指向生成的文本片段的指针。|
|len|生成的文本片段长度。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空或len为0。|

### HMS_LLMEngineContext_GetOneGenerationLen()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineContext_GetOneGenerationLen (const HMS_LLMEngine_Context * ctx, uint32_t * len )
```

**描述**

获取生成文本片段的长度。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:--|:------------------------------------------------------------|
|ctx|指向[HMS_LLMEngine_Context](#hms_llmengine_context)的指针，不能为null。|
|len|生成的文本片段长度。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空或len为0。|

### HMS_LLMEngineContext_GetOneTokenGeneration()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineContext_GetOneTokenGeneration (const HMS_LLMEngine_Context * ctx, int32_t * genToken )
```

**描述**

获取生成的tokenid。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:-------|:------------------------------------------------------------|
|ctx|指向[HMS_LLMEngine_Context](#hms_llmengine_context)的指针，不能为null。|
|genToken|指向生成的tokenid的指针。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空。|

### HMS_LLMEngineContext_GetOutputTokenCount()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineContext_GetOutputTokenCount (const HMS_LLMEngine_Context * ctx, uint64_t * count )
```

**描述**

输出token数量。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:----|:------------------------------------------------------------|
|ctx|指向[HMS_LLMEngine_Context](#hms_llmengine_context)的指针，不能为null。|
|count|输出token数量。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空。|

### HMS_LLMEngineContext_GetPrefillTimeMs()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineContext_GetPrefillTimeMs (const HMS_LLMEngine_Context * ctx, double * ms )
```

**描述**

LLM引擎预填充阶段消耗时间。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:--|:--------------------------------------------------------------|
|ctx|指向 [HMS_LLMEngine_Context](#hms_llmengine_context) 的指针，不能为null。|
|ms|预填充时间（单位：ms）。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空。|

### HMS_LLMEngineContext_GetTotalTimeMs()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineContext_GetTotalTimeMs (const HMS_LLMEngine_Context * ctx, double * ms )
```

**描述**

生成阶段总耗时。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:--|:--------------------------------------------------------------|
|ctx|指向 [HMS_LLMEngine_Context](#hms_llmengine_context) 的指针，不能为null。|
|ms|生成总耗时（单位：ms）。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空。|

### HMS_LLMEngineContext_SetOnAllTokensGenerateDoneFunc()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineContext_SetOnAllTokensGenerateDoneFunc (HMS_LLMEngine_Context * ctx, callbackFunctionType func )
```

**描述**

设置所有token生成完毕时触发的回调函数。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:---|:------------------------------------------------------------|
|ctx|指向[HMS_LLMEngine_Context](#hms_llmengine_context)的指针，不能为null。|
|func|上下文回调函数。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空。|

### HMS_LLMEngineContext_SetOnGenerateAsyncFailed()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineContext_SetOnGenerateAsyncFailed (HMS_LLMEngine_Context * ctx, callbackFunctionType func )
```

**描述**

设置生成失败时的回调函数。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:---|:------------------------------------------------------------|
|ctx|指向[HMS_LLMEngine_Context](#hms_llmengine_context)的指针，不能为null。|
|func|上下文回调函数。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空。|

### HMS_LLMEngineContext_SetOnOneTokenGenerateDoneFunc()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineContext_SetOnOneTokenGenerateDoneFunc (HMS_LLMEngine_Context * ctx, callbackFunctionType func )
```

**描述**

设置生成token时触发的回调函数。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:---|:------------------------------------------------------------|
|ctx|指向[HMS_LLMEngine_Context](#hms_llmengine_context)的指针，不能为null。|
|func|上下文回调函数。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空。|

### HMS_LLMEngineExecutor_CreateFromExecutorJson()

> 2in1 6.1.1(24)+

```cpp
HMS_LLMEngine_Executor* HMS_LLMEngineExecutor_CreateFromExecutorJson (const char * jsonFile)
```

**描述**

通过JSON配置文件创建LLM引擎执行器句柄。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:-------|:----------------|
|jsonFile|JSON配置文件的路径，不能为空。|

**返回：**

创建的LLM引擎执行器句柄。

### HMS_LLMEngineExecutor_Destroy()

> 2in1 6.1.1(24)+

```cpp
void HMS_LLMEngineExecutor_Destroy (HMS_LLMEngine_Executor ** executor)
```

**描述**

销毁一个LLM引擎执行器，该执行器内存释放。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:-------|:-------|
|executor|待销毁的执行器。|

### HMS_LLMEngineExecutor_Generate()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineExecutor_Generate (HMS_LLMEngine_Executor * executor, HMS_LLMEngine_Context * ctx, const HMS_LLMEngine_Prompt * prompt )
```

**描述**

执行同步LLM推理。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:-------|:--------------------------------------------------------------|
|executor|指向[HMS_LLMEngine_Executor](#hms_llmengine_executor)的指针，不能为null。|
|ctx|指向[HMS_LLMEngine_Context](#hms_llmengine_context)的指针，不能为null。|
|prompt|同步LLM推理的输入。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空。|

### HMS_LLMEngineExecutor_GenerateAsync()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineExecutor_GenerateAsync (HMS_LLMEngine_Executor * executor, HMS_LLMEngine_Context * ctx, const HMS_LLMEngine_Prompt * prompt )
```

**描述**

异步执行LLM推理。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:-------|:--------------------------------------------------------------|
|executor|指向[HMS_LLMEngine_Executor](#hms_llmengine_executor)的指针，不能为null。|
|ctx|指向[HMS_LLMEngine_Context](#hms_llmengine_context)的指针，不能为null。|
|prompt|异步LLM推理的输入。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:---------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空。|

### HMS_LLMEngineExecutor_SetInferencePerfMode()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEngineExecutor_SetInferencePerfMode (HMS_LLMEngine_Executor * executor, HMS_LLMEngine_InferPerfMode inferPerfMode )
```

**描述**

设置推理性能模式。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:------------|:----------------------------------------------------------------------|
|executor|指向[HMS_LLMEngine_Executor](#hms_llmengine_executor)的指针，不能为null。|
|inferPerfMode|[HMS_LLMEngine_InferPerfMode](#hms_llmengine_inferperfmode)枚举值，不能为null。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:-------------------------------------------------------------------------------------------------------------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态。 可能原因：入参executor为空；入参inferPerfMode大于HMS_LLMENGINE_INFERPERF_EXTREME_HIGH或小于HMS_LLMENGINE_INFERPERF_UNSET。|

### HMS_LLMEnginePrompt_Create()

> 2in1 6.1.1(24)+

```cpp
HMS_LLMEngine_Prompt* HMS_LLMEnginePrompt_Create (void )
```

**描述**

创建一个LLM引擎提示句柄。

**起始版本：** 6.1.1(24)

**返回：**

创建的LLM引擎提示句柄。

### HMS_LLMEnginePrompt_Destroy()

> 2in1 6.1.1(24)+

```cpp
void HMS_LLMEnginePrompt_Destroy (HMS_LLMEngine_Prompt ** prompt)
```

**描述**

销毁LLM引擎提示词句柄。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:-----|:--------------|
|prompt|待销毁的LLM引擎提示词句柄。|

### HMS_LLMEnginePrompt_SetText()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEnginePrompt_SetText (HMS_LLMEngine_Prompt * prompt, const char * text )
```

**描述**

设置文本输入。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:-----|:----------------------------------------------------------|
|prompt|指向[HMS_LLMEngine_Prompt](#hms_llmengine_prompt)的指针，不能为null。|
|text|文本提示词。|

### HMS_LLMEnginePrompt_SetTokenId()

> 2in1 6.1.1(24)+

```cpp
OH_NN_ReturnCode HMS_LLMEnginePrompt_SetTokenId (HMS_LLMEngine_Prompt * prompt, int32_t * tokenIds, uint32_t tokenNum )
```

**描述**

设置输入的tokenid。

**起始版本：** 6.1.1(24)

**参数：**

|名称|描述|
|:-------|:----------------------------------------------------------|
|prompt|指向[HMS_LLMEngine_Prompt](#hms_llmengine_prompt)的指针，不能为null。|
|tokenIds|要设置到提示词中的tokenid。|
|tokenNum|tokenid的数量。|

**返回：**

接口执行状态，参见[OH_NN_ReturnCode](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-neural-network-runtime-type-h#oh_nn_returncode)。

|状态码|状态信息|
|:------------|:--------------------|
|OH_NN_SUCCESS|成功状态。|
|OH_NN_FAILED|失败状态，入参为空或tokenNum为0。|