NIMAIManagerProtocol.h

浏览该文件的文档.

//
//  NIMAIManagerProtocol.h
//  NIMLib
//
//  Created by 崔生余 on 2024/5/20.
//  Copyright © 2024 Netease. All rights reserved.
//
 
#import <Foundation/Foundation.h>
#import "NIMUserManagerProtocol.h"
#import "NIMUser.h"
 
NS_ASSUME_NONNULL_BEGIN
 
@class NIMProxyAIModelCallParams;
@class NIMAIModelCallContent;
@class NIMAIUser;
@class NIMProxyAICallAntispamConfig;
@class NIMAIModelCallResult;
@class NIMAIRAGInfo;
@class NIMAIModelStreamCallResult;
@class NIMAIModelStreamCallStopParams;
 
@protocol NIMAIListDelegate;
 
/// 数字人拉取接口的回调
typedef void(^NIMGetAlUserListBlock)(NSError * __nullable error,NSArray <NIMAIUser *> * _Nullable result);
/// Al数字人请求代理接口的回调
typedef void(^NIMProxyAIModelCallBlock)(NSError * __nullable error);
/// Al数字人停止
typedef void(^NIMStopAIModelStreamCallBlock)(NSError * __nullable error);
 
/// 大模型类型
typedef NS_ENUM(NSInteger, NIMAIModelType) {
    NIMAIModelTypeUnknow, // 未知
    NIMAIModelTypeQwen,   // 通义千问大模型
    NIMAIModelTypeAzure,  // 微软Azure
    NIMAIModelTypePrivate // 私有本地大模型
};
 
 
/// 大模型请求内容类型
typedef NS_ENUM(NSInteger, NIMAIModelCallContentType) {
    NIMAIModelCallContentTypeText = 0 // 暂时只有0，代表文本，预留扩展能力
};
 
/// 大模型角色内容
typedef NS_ENUM(NSInteger, NIMAIModelRoleType) {
    NIMAIModelRoleTypeSystem,
    NIMAIModelRoleTypeUser,
    NIMAIModelRoleTypeAssistant
};
 
/// 数字人流式消息状态
typedef NS_ENUM(NSInteger, NIMAIModelStreamCallStatus) {
    /// 非流式状态
    NIM_AI_MODEL_STREAM_CALL_STATUS_NONE = 0,
    
    /// 停止输出
    NIM_AI_MODEL_STREAM_CALL_STATUS_CANCEL = 2,
    
    /// 输出完成
    NIM_AI_MODEL_STREAM_CALL_STATUS_GENERATED = 4,
    
    /// 服务器异常终止
    NIM_AI_MODEL_STREAM_CALL_STATUS_ABORTED = 5,
};
 
@protocol NIMAIManager <NSObject>
 
/**
 *  数字人拉取接口
 *  返回全量的本Appkey相关的数字人用户
 *
 *  @param completion  完成后的回调
 */
- (void)getAIUserList:(NIMGetAlUserListBlock)completion;
 
 
/**
 *  Al数字人请求代理接口
 *
 *  @param params   接口入参
 *  @param completion  完成后的回调
 */
 
- (void)proxyAIModelCall:(NIMProxyAIModelCallParams *)params
                completion:(NIMProxyAIModelCallBlock)completion;
 
 
/**
 * 停止流式输出
 *
 *  @param params   接口入参
 *  @param completion  完成后的回调
 */
- (void)stopAIModelStreamCall:(NIMAIModelStreamCallStopParams *)params
                   completion:(NIMStopAIModelStreamCallBlock)completion;
 
 
/**
* 添加数字人监听器
*
* @param listener 消息监听回调
*/
- (void)addDelegate:(id<NIMAIListDelegate>)listener;
 
/**
* 删除数字人监听器
*
* @param listener 消息监听回调
*/
- (void)removeDelegate:(id<NIMAIListDelegate>)listener;
 
@end
 
// Al数字人监听
@protocol NIMAIListDelegate <NSObject>
@optional
 
/**
 *  AI透传接口的响应的回调
 *  接口调用完毕后, 接下来服务器响应以通知的形式下发, 端测需要触发回调提供.
 *  @param data  响应内容
 */
- (void)onProxyAIModelCall:(NIMAIModelCallResult *)data;
 
/**
 *  AI 透传接口的流式响应的回调
 *  流式过程中回调此方法，流式结束后还是会统一调用onProxyAIModelCall方法
 *  @param data 本次响应的结构体
 */
- (void)onProxyAIModelStreamCall:(NIMAIModelStreamCallResult *)data;
 
@end
 
 
@interface NIMAIModelCallContent : NSObject<NSCopying>
 
/// 请求/响应的文本内容
@property(nonatomic,copy) NSString *msg;
 
/// 类型,暂时只有0，代表文本，预留扩展能力
@property(nonatomic,assign) NIMAIModelCallContentType type;
 
@end
 
/// 请求调用上下文内容
@interface NIMAIModelCallMessage : NSObject
 
/// 上下文内容的角色
@property(nonatomic,assign) NIMAIModelRoleType role;
 
/// 上下文内容的内容
@property(nonatomic,copy) NSString *msg;
 
/// 类型
@property(nonatomic,assign) NIMAIModelCallContentType type;
 
@end
 
/**
 *  Ai 大模型配置覆盖， 配置了该字段， 则默认覆盖控制台相关配置
 *  如果所有字段均为空，则以控制台配置为准， 本地不做格式校验
 *  如果设置参数超过范围， 则会主动纠正到正确范围
 */
@interface NIMAIModelConfigParams : NSObject<NSCopying>
 
/// 提示词
@property(nullable,nonatomic,copy) NSString *prompt;
 
/// 模型最大tokens数量
@property(nonatomic,assign) NSInteger maxTokens;
 
/**
 *  取值范围（0，1），生成时，核采样方法的概率阈值。
 *  例如，取值为0.8时，仅保留累计概率之和大于等于0.8的概率分布中的token，作为随机采样的候选集。取值范围为（0,1.0)，取值越大，生成的随机性越高；取值越低，生成的随机性越低。
 *  默认值 0.5。注意，取值不要大于等于1
 */
 
@property(nonatomic,assign) CGFloat topP;
 
/**
 *  取值范围(0,2)，用于控制随机性和多样性的程度。
 *  具体来说，temperature值控制了生成文本时对每个候选词的概率分布进行平滑的程度。较高的temperature值会降低概率分布的峰值，使得更多的低概率词被选择，生成结果更加多样化；而较低的temperature值则会增强概率分布的峰值，使得高概率词更容易被选择，生成结果更加确定。
 */
@property(nonatomic,assign) CGFloat temperature;
 
@end
 
@interface NIMProxyAIModelCallParams : NSObject
 
/// 机器人账号ID
@property(nonatomic,copy) NSString *accountId;
 
/// 请求id
@property(nonatomic,copy) NSString *requestId;
 
/// 请求大模型的内容
@property(nonatomic,strong) NIMAIModelCallContent *content;
 
/// 上下文内容
@property(nullable,nonatomic,strong) NSArray<NIMAIModelCallMessage *> *messages;
 
/// 提示词变量占位符替换
/// JSON 格式的字符串
/// 用于填充prompt中的变量
@property(nullable,nonatomic,copy) NSString *promptVariables;
 
/// 请求接口模型相关参数配置， 如果参数不为空，则默认覆盖控制相关配置
@property(nullable,nonatomic,strong) NIMAIModelConfigParams *modelConfigParams;
 
/// AI 透传接口的反垃圾配置
@property(nullable,nonatomic,strong) NIMProxyAICallAntispamConfig *antispamConfig;
 
/// 是否是流式响应，默认NO
@property(nonatomic,assign,readwrite) BOOL aiStream;
@end
 
@interface NIMAIModelConfig : NSObject
 
/// 具体大模型版本模型名
@property(nonatomic,copy) NSString *model;
 
/// 提示词
@property(nonatomic,copy) NSString *prompt;
 
/// 提示词对应的变量
@property(nullable,nonatomic,strong) NSArray *promptKeys;
 
/// 模型最大tokens数量
@property(nonatomic,assign) NSInteger maxTokens;
 
/**
 *  取值范围（0，1），生成时，核采样方法的概率阈值。
 *  例如，取值为0.8时，仅保留累计概率之和大于等于0.8的概率分布中的token，作为随机采样的候选集。取值范围为（0,1.0)，取值越大，生成的随机性越高；取值越低，生成的随机性越低。
 *  默认值 0.5。注意，取值不要大于等于1
 */
 
@property(nonatomic,assign) CGFloat topP;
 
/**
 *  取值范围(0,2)，用于控制随机性和多样性的程度。
 *  具体来说，temperature值控制了生成文本时对每个候选词的概率分布进行平滑的程度。较高的temperature值会降低概率分布的峰值，使得更多的低概率词被选择，生成结果更加多样化；而较低的temperature值则会增强概率分布的峰值，使得高概率词更容易被选择，生成结果更加确定。
 */
@property(nonatomic,assign) CGFloat temperature;
 
@end
 
@interface NIMAIUser: NIMUserInfo
 
/// 大模型类型
@property(nonatomic,assign) NIMAIModelType modelType;
 
/// 模型相关配置信息
@property(nullable,nonatomic) NIMAIModelConfig *modelConfig;
 
@end
 
 
@interface NIMProxyAICallAntispamConfig : NSObject
/// 指定消息是否需要经过安全通。默认为 true
/// 对于已开通安全通的用户有效，默认消息都会走安全通，如果对单条消息设置 enable 为 false，则此消息不会走安全通
@property(nonatomic,assign) BOOL antispamEnabled;
 
/// 指定易盾业务id
@property(nullable,nonatomic,copy) NSString *antispamBusinessId;
@end
 
@interface NIMAIModelCallResult : NSObject
 
/// 数字人的accountId
@property(nonatomic,copy) NSString *accountId;
 
/// 本次响应的标识
@property(nonatomic,copy) NSString *requestId;
 
/// 请求AI的回复
@property(nonatomic,strong) NIMAIModelCallContent *content;
 
/// AI响应的状态码
@property(nonatomic,assign) NSInteger code;
 
/// 数字人回复内容的引用资源列表
@property (nonatomic, strong) NSArray<NIMAIRAGInfo *> *aiRAGs;
 
/// 回复的时间戳
@property (nonatomic, assign) NSTimeInterval timestamp;
 
/// 是否是流式响应，默认false
@property (nonatomic, assign) BOOL aiStream;
 
/// 数字人流式响应状态
@property (nonatomic, assign) NIMAIModelStreamCallStatus aiStreamStatus;
 
@end
 
/// 透传协议流式分片信息
@interface NIMAIModelStreamCallChunk : NSObject
 
/// 数字人流式回复分片文本
@property (nonatomic, copy) NSString *content;
 
/// 数字人流式回复当前分片时间
@property (nonatomic, assign) NSTimeInterval chunkTime;
 
/// 类型，当前仅支持0表示文本
@property (nonatomic, assign) NSInteger type;
 
/// 分片序号，从0开始
@property (nonatomic, assign) NSInteger index;
 
@end
 
/// 流式回复内容
@interface NIMAIModelStreamCallContent : NSObject
 
/// 数字人流式回复分片组装好的文本
@property (nonatomic, copy, readonly) NSString *msg;
 
/// 类型，当前仅支持0表示文本
@property (nonatomic, assign, readonly) NSInteger type;
 
/// 数字人流式回复最近一个分片
@property (nonatomic, strong, readonly) NIMAIModelStreamCallChunk *lastChunk;
 
@end
 
/// 透传接口的 AI 流式回复的结构体
@interface NIMAIModelStreamCallResult : NSObject
 
/// AI 响应的状态码
@property (nonatomic, assign, readonly) NSInteger code;
 
/// 数字人的 accountId
@property (nonatomic, copy, readonly) NSString *accountId;
 
/// 本次响应的标识
@property (nonatomic, copy, readonly) NSString *requestId;
 
/// 请求 AI 的回复
@property (nonatomic, strong, readonly) NIMAIModelStreamCallContent *content;
 
/// 数字人回复内容的引用资源列表
/// 第一个分片才下发
@property (nonatomic, copy, readonly) NSArray<NIMAIRAGInfo *> *aiRAGs;
 
/// 分片的时间戳
@property (nonatomic, assign, readonly) NSTimeInterval timestamp;
 
@end
 
/// 停止透传接口的 AI 流式回复
@interface NIMAIModelStreamCallStopParams : NSObject
 
/// 机器人账号ID
/// AIUser对应的账号ID
@property (nonatomic, copy) NSString *accountId;
 
/// 请求id
@property (nonatomic, copy) NSString *requestId;
 
@end
 
NS_ASSUME_NONNULL_END