OpenMax
免费试用

一行接入

@openmaxai/chat-openmax/react 的 createChatHost:收 OpenMax 构造参数,并转出 Provider 与列表 hook。

一行接入

@openmaxai/chat-openmax/react 是接 OpenMax 的一行入口:createChatHost 收构造参数造宿主;ChatProvider、ConversationScope、useChatSdkConversationList 和类型 ChatSdkHost、ChatSdkAdapterProfiles、ChatSdkProfileCardActions 从 @openmaxai/chat-sdk/react 原样再导出,说明见 @openmaxai/chat-sdk · 宿主。接 OpenMax 时只从这一个入口引入就够了。状态和全部导出的索引见概览。

createChatHost

function createChatHost(config: OpenMaxOneLineConfig): ChatSdkHost;
function createChatHost(config: ChatSdkAdapterHostConfig): ChatSdkHost;

两种调用形式:第一种收 OpenMax 构造参数,OpenMaxOneLineConfig 是 OpenMaxChatConfig 加上 onUnauthorized?: never、onEvent?: never、cards?: never、profileCardActions?: never 与 attachments?: never、uploads?: never、resolveUrls?: never、resolveDownloadUrl?: never,不导出;第二种收 ChatSdkAdapterHostConfig({ adapter, ... }),原样转交给 @openmaxai/chat-sdk/react 的 createChatHost。

收构造参数时,用 createOpenMaxAdapter 造适配器,连同 storage、instanceKey、locale、ports 和 markdown 交给 @openmaxai/chat-sdk/react 的 createChatHost 组装。

  • 同步。 构造时不发请求、不调 getToken。当前用户回来之前 identity.currentUserId() 是空串,数据到了经 ChatProvider 重渲染。
  • 构造参数不合法时同步抛 ChatSdkConfigError,规则见 OpenMaxChatConfig。
  • 不收 onUnauthorized。 类型上就不收(TypeScript 编译不过);JS 调用方给了,建宿主时同步抛 ChatSdkConfigError,报错里写明改法。凭据失效时失败的调用照旧抛 kind 为 unauthorized 的 ChatSdkRequestError,实时不再重连,SDK 经 attention.notify 提示一次「登录已过期」。要回调,改用 createChatHost({ adapter: createOpenMaxAdapter(config), onUnauthorized })。这是已知缺口,见已知缺口与版本。
  • 不收 onEvent,处置同 onUnauthorized:类型上不收,JS 里给了建宿主时同步抛 ChatSdkConfigError。要接事件,改用 createChatHost({ adapter: createOpenMaxAdapter(config), onEvent })。
  • 不收 cards,处置同 onEvent:类型上不收,JS 里给了建宿主时同步抛 ChatSdkConfigError。一行写法造的宿主上业务卡按钮不画;要接卡片能力,改用 { adapter } 写法,把放行哪些业务操作交在那里:createChatHost({ adapter: createOpenMaxAdapter(config), cards: { isOperationAllowed } })。
  • 不收 profileCardActions,处置同 cards:一行写法造的宿主没有名片;要名片,改用 createChatHost({ adapter: createOpenMaxAdapter(config), profileCardActions })。
  • 不认识的键不抛错,忽略。 开发模式下宿主第一次挂上 ChatProvider 时每个不认识的键 console.error 一次,点名该键并指到正确位置:attachments、uploads、resolveUrls、resolveDownloadUrl 说明附件由 OpenMax 适配器按 baseUrl 与 auth 自己接好、要换就改用 { adapter } 写法换适配器的 uploads;routeConversation 等 { adapter } 写法才有的键指到 { adapter } 写法;端口名指到 ports.<name>。按宿主只报一次。打包后的生产构建不输出(文案仍留在产物里);未经打包器直接用源码时按开发模式处理,照样报。attachments、uploads、resolveUrls、resolveDownloadUrl 在类型上是 never,两种调用形式都编译不过;{ adapter } 写法里其余不认识的键由 @openmaxai/chat-sdk/react 的 createChatHost 报。
  • 造出的宿主上,inboundDelivery 的 endpointUrl、authToken、clientId 是空串、undefined、空串。

原来从 @openmaxai/chat-sdk/react 引入 createChatHost 接 OpenMax 的代码,只改 import 路径,构造参数形状不变;@openmaxai/chat-sdk/react 的 createChatHost 只收 { adapter },给它 OpenMax 构造参数会同步抛 ChatSdkConfigError。