@aws-amplify/data-schema 1.12.2 → 1.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/data-schema",
-  "version": "1.12.2",
+  "version": "1.13.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",

package/src/ClientSchema/ai/ClientConversation.ts

@@ -4,6 +4,7 @@
 import type {
   Conversation,
   ConversationMessage,
+  ConversationStreamEvent,
 } from '../../ai/ConversationType';
 import type { ClientSchemaProperty } from '../Core';
 
@@ -12,4 +13,5 @@ export interface ClientConversation
   __entityType: 'customConversation';
   type: Conversation;
   messageType: ConversationMessage;
+  streamEventType: ConversationStreamEvent;
 }

package/src/ai/ConversationSchemaTypes.ts

@@ -230,6 +230,25 @@ const ToolInputSchema = `type ToolInputSchema {
   json: AWSJSON
 }`;
 
+const ConversationMessageStreamEvent = `type ConversationMessageStreamPart @aws_cognito_user_pools {
+  id: ID!
+  owner: String
+  conversationId: ID!
+  associatedUserMessageId: ID!
+  contentBlockIndex: Int!
+  contentBlockText: String
+  contentBlockDeltaIndex: Int
+  contentBlockToolUse: ToolUseBlock
+  contentBlockDoneAtIndex: Int
+  stopReason: String
+  errors: [ConversationTurnError]
+}`;
+
+const ConversationTurnError = `type ConversationTurnError @aws_cognito_user_pools {
+  message: String!
+  errorType: String!
+}`;
+
 export const conversationTypes: string[] = [
   ConversationParticipantRole,
   ConversationMessage,
@@ -262,4 +281,6 @@ export const conversationTypes: string[] = [
   Tool,
   ToolSpecification,
   ToolInputSchema,
+  ConversationMessageStreamEvent,
+  ConversationTurnError,
 ];

package/src/ai/ConversationType.ts

@@ -12,6 +12,7 @@ import {
 } from './types/ConversationMessageContent';
 import { ToolConfiguration } from './types/ToolConfiguration';
 import { AiModel } from '@aws-amplify/data-schema-types';
+import { ConversationStreamErrorEvent, ConversationStreamEvent } from './types/ConversationStreamEvent';
 
 export const brandName = 'conversationCustomOperation';
 
@@ -22,6 +23,7 @@ export interface ConversationMessage {
   createdAt: string;
   id: string;
   role: 'user' | 'assistant';
+  associatedUserMessageId?: string;
 }
 
 // conversation route types
@@ -104,7 +106,10 @@ interface ConversationListMessagesInput {
   nextToken?: string | null;
 }
 
-type ConversationOnMessageHandler = (message: ConversationMessage) => void;
+type ConversationOnStreamEventHandler = {
+  next: (event: ConversationStreamEvent) => void;
+  error: (error: ConversationStreamErrorEvent) => void;
+};
 
 export interface Conversation {
   id: string;
@@ -132,9 +137,9 @@ export interface Conversation {
   /**
    * @experimental
    *
-   * Subscribes to new messages on the current conversation.
+   * Subscribes to new stream events on the current conversation.
    */
-  onMessage: (handler: ConversationOnMessageHandler) => Subscription;
+  onStreamEvent: (handler: ConversationOnStreamEventHandler) => Subscription;
 }
 
 // schema definition input
@@ -185,3 +190,5 @@ function _conversation(input: ConversationInput): ConversationType {
 export function conversation(input: ConversationInput): ConversationType {
   return _conversation(input);
 }
+export { ConversationStreamEvent };
+

package/src/ai/types/ConversationStreamEvent.ts

@@ -0,0 +1,70 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { ToolUseBlock } from "./contentBlocks";
+
+export interface ConversationStreamTextEvent {
+  id: string;
+  conversationId: string;
+  associatedUserMessageId: string;
+  contentBlockIndex: number;
+  contentBlockDeltaIndex: number;
+  contentBlockDoneAtIndex?: never;
+  text: string;
+  toolUse?: never;
+  stopReason?: never;
+}
+
+export interface ConversationStreamToolUseEvent {
+  id: string;
+  conversationId: string;
+  associatedUserMessageId: string;
+  contentBlockIndex: number;
+  contentBlockDeltaIndex?: never;
+  contentBlockDoneAtIndex?: never;
+  text?: never;
+  toolUse: ToolUseBlock;
+  stopReason?: never;
+}
+
+export interface ConversationStreamDoneAtIndexEvent {
+  id: string;
+  conversationId: string;
+  associatedUserMessageId: string;
+  contentBlockIndex: number;
+  contentBlockDoneAtIndex: number;
+  contentBlockDeltaIndex?: never;
+  text?: never;
+  toolUse?: never;
+  stopReason?: never;
+}
+
+export interface ConversationStreamTurnDoneEvent {
+  id: string;
+  conversationId: string;
+  associatedUserMessageId: string;
+  contentBlockIndex: number;
+  contentBlockDoneAtIndex?: never;
+  contentBlockDeltaIndex?: never;
+  text?: never;
+  toolUse?: never;
+  stopReason: string;
+}
+
+export interface ConversationStreamErrorEvent {
+  id: string;
+  conversationId: string;
+  associatedUserMessageId: string;
+  errors: ConversationTurnError[]
+}
+
+export interface ConversationTurnError {
+  message: string;
+  errorType: string;
+}
+
+export type ConversationStreamEvent =
+  | ConversationStreamTextEvent
+  | ConversationStreamToolUseEvent
+  | ConversationStreamDoneAtIndexEvent
+  | ConversationStreamTurnDoneEvent;

package/src/runtime/internals/ai/conversationStreamEventDeserializers.ts

@@ -0,0 +1,62 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { ConversationStreamEvent } from "../../../ai/ConversationType";
+import { ToolUseBlock } from "../../../ai/types/contentBlocks";
+import { ConversationStreamErrorEvent } from "../../../ai/types/ConversationStreamEvent";
+
+export const convertItemToConversationStreamEvent =  ({
+  id,
+  conversationId,
+  associatedUserMessageId,
+  contentBlockIndex,
+  contentBlockDoneAtIndex,
+  contentBlockDeltaIndex,
+  contentBlockText,
+  contentBlockToolUse,
+  stopReason,
+  errors,
+}: any): { next?: ConversationStreamEvent, error?: ConversationStreamErrorEvent } => {
+  if (errors) {
+    const error = {
+      id,
+      conversationId,
+      associatedUserMessageId,
+      errors,
+    };
+    return { error };
+  }
+  const next = removeNullsFromConversationStreamEvent({
+    id,
+    conversationId,
+    associatedUserMessageId,
+    contentBlockIndex,
+    contentBlockDoneAtIndex,
+    contentBlockDeltaIndex,
+    text: contentBlockText,
+    toolUse: deserializeToolUseBlock(contentBlockToolUse),
+    stopReason,
+  });
+
+  return { next };
+};
+
+const deserializeToolUseBlock = (
+  contentBlockToolUse: any,
+): ToolUseBlock | undefined => {
+  if (contentBlockToolUse) {
+    const toolUseBlock = {
+      ...contentBlockToolUse,
+      input: JSON.parse(contentBlockToolUse.input),
+    };
+
+    return toolUseBlock;
+  }
+};
+
+const removeNullsFromConversationStreamEvent = (
+  block: ConversationStreamEvent,
+): ConversationStreamEvent =>
+  Object.fromEntries(
+    Object.entries(block).filter(([_, v]) => v !== null),
+  ) as ConversationStreamEvent;

package/src/runtime/internals/ai/convertItemToConversation.ts

@@ -10,7 +10,7 @@ import type {
   SchemaModel,
 } from '../../bridge-types';
 import { createListMessagesFunction } from './createListMessagesFunction';
-import { createOnMessageFunction } from './createOnMessageFunction';
+import { createOnStreamEventFunction } from './createOnStreamEventFunction';
 import { createSendMessageFunction } from './createSendMessageFunction';
 
 export const convertItemToConversation = (
@@ -36,7 +36,7 @@ export const convertItemToConversation = (
     updatedAt: conversationUpdatedAt,
     metadata: conversationMetadata,
     name: conversationName,
-    onMessage: createOnMessageFunction(
+    onStreamEvent: createOnStreamEventFunction(
       client as BaseBrowserClient,
       modelIntrospection,
       conversationId,

package/src/runtime/internals/ai/convertItemToConversationMessage.ts

@@ -10,7 +10,7 @@ export const convertItemToConversationMessage = ({
   conversationId,
   role,
 }: any) => ({
-  content: deserializeContent(content),
+  content: deserializeContent(content ?? []),
   conversationId,
   createdAt,
   id,

package/src/runtime/internals/ai/{createOnMessageFunction.ts → createOnStreamEventFunction.ts}

@@ -9,17 +9,17 @@ import {
   ModelIntrospectionSchema,
 } from '../../bridge-types';
 import { customOpFactory } from '../operations/custom';
-import { convertItemToConversationMessage } from './convertItemToConversationMessage';
 import { AiAction, getCustomUserAgentDetails } from './getCustomUserAgentDetails';
+import { convertItemToConversationStreamEvent } from './conversationStreamEventDeserializers';
 
-export const createOnMessageFunction =
+export const createOnStreamEventFunction =
   (
     client: BaseClient,
     modelIntrospection: ModelIntrospectionSchema,
     conversationId: string,
     conversationRouteName: string,
     getInternals: ClientInternalsGetter,
-  ): Conversation['onMessage'] =>
+  ): Conversation['onStreamEvent'] =>
   (handler): Subscription => {
     const { conversations } = modelIntrospection;
     // Safe guard for standalone function. When called as part of client generation, this should never be falsy.
@@ -35,9 +35,11 @@ export const createOnMessageFunction =
       subscribeSchema,
       false,
       getInternals,
-      getCustomUserAgentDetails(AiAction.OnMessage),
+      getCustomUserAgentDetails(AiAction.OnStreamEvent),
     ) as (args?: Record<string, any>) => Observable<any>;
     return subscribeOperation({ conversationId }).subscribe((data) => {
-      handler(convertItemToConversationMessage(data));
+      const { next, error } = convertItemToConversationStreamEvent(data);
+      if (error) handler.error(error);
+      if (next) handler.next(next);
     });
   };

package/src/runtime/internals/ai/getCustomUserAgentDetails.ts

@@ -24,7 +24,7 @@ export enum AiAction {
   DeleteConversation = '4',
   SendMessage = '5',
   ListMessages = '6',
-  OnMessage = '7',
+  OnStreamEvent = '7',
   Generation = '8',
   UpdateConversation = '9',
 }

package/dist/cjs/runtime/internals/ai/createOnMessageFunction.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createOnMessageFunction.js","sources":["../../../../../src/runtime/internals/ai/createOnMessageFunction.ts"],"sourcesContent":["\"use strict\";\n// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.createOnMessageFunction = void 0;\nconst custom_1 = require(\"../operations/custom\");\nconst convertItemToConversationMessage_1 = require(\"./convertItemToConversationMessage\");\nconst getCustomUserAgentDetails_1 = require(\"./getCustomUserAgentDetails\");\nconst createOnMessageFunction = (client, modelIntrospection, conversationId, conversationRouteName, getInternals) => (handler) => {\n    const { conversations } = modelIntrospection;\n    // Safe guard for standalone function. When called as part of client generation, this should never be falsy.\n    if (!conversations) {\n        return {};\n    }\n    const subscribeSchema = conversations[conversationRouteName].message.subscribe;\n    const subscribeOperation = (0, custom_1.customOpFactory)(client, modelIntrospection, 'subscription', subscribeSchema, false, getInternals, (0, getCustomUserAgentDetails_1.getCustomUserAgentDetails)(getCustomUserAgentDetails_1.AiAction.OnMessage));\n    return subscribeOperation({ conversationId }).subscribe((data) => {\n        handler((0, convertItemToConversationMessage_1.convertItemToConversationMessage)(data));\n    });\n};\nexports.createOnMessageFunction = createOnMessageFunction;\n"],"names":[],"mappings":";;AACA;AACA;AACA,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAC9D,OAAO,CAAC,uBAAuB,GAAG,KAAK,CAAC,CAAC;AACzC,MAAM,QAAQ,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;AACjD,MAAM,kCAAkC,GAAG,OAAO,CAAC,oCAAoC,CAAC,CAAC;AACzF,MAAM,2BAA2B,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAC;AAC3E,MAAM,uBAAuB,GAAG,CAAC,MAAM,EAAE,kBAAkB,EAAE,cAAc,EAAE,qBAAqB,EAAE,YAAY,KAAK,CAAC,OAAO,KAAK;AAClI,IAAI,MAAM,EAAE,aAAa,EAAE,GAAG,kBAAkB,CAAC;AACjD;AACA,IAAI,IAAI,CAAC,aAAa,EAAE;AACxB,QAAQ,OAAO,EAAE,CAAC;AAClB,KAAK;AACL,IAAI,MAAM,eAAe,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;AACnF,IAAI,MAAM,kBAAkB,GAAG,IAAI,QAAQ,CAAC,eAAe,EAAE,MAAM,EAAE,kBAAkB,EAAE,cAAc,EAAE,eAAe,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,2BAA2B,CAAC,yBAAyB,EAAE,2BAA2B,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;AAC3P,IAAI,OAAO,kBAAkB,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,KAAK;AACtE,QAAQ,OAAO,CAAC,IAAI,kCAAkC,CAAC,gCAAgC,EAAE,IAAI,CAAC,CAAC,CAAC;AAChG,KAAK,CAAC,CAAC;AACP,CAAC,CAAC;AACF,OAAO,CAAC,uBAAuB,GAAG,uBAAuB;;"}

package/dist/esm/runtime/internals/ai/createOnMessageFunction.d.ts

@@ -1,3 +0,0 @@
-import type { Conversation } from '../../../ai/ConversationType';
-import { BaseClient, ClientInternalsGetter, ModelIntrospectionSchema } from '../../bridge-types';
-export declare const createOnMessageFunction: (client: BaseClient, modelIntrospection: ModelIntrospectionSchema, conversationId: string, conversationRouteName: string, getInternals: ClientInternalsGetter) => Conversation['onMessage'];

package/dist/esm/runtime/internals/ai/createOnMessageFunction.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"createOnMessageFunction.mjs","sources":["../../../../../src/runtime/internals/ai/createOnMessageFunction.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { customOpFactory } from '../operations/custom';\nimport { convertItemToConversationMessage } from './convertItemToConversationMessage';\nimport { AiAction, getCustomUserAgentDetails } from './getCustomUserAgentDetails';\nexport const createOnMessageFunction = (client, modelIntrospection, conversationId, conversationRouteName, getInternals) => (handler) => {\n    const { conversations } = modelIntrospection;\n    // Safe guard for standalone function. When called as part of client generation, this should never be falsy.\n    if (!conversations) {\n        return {};\n    }\n    const subscribeSchema = conversations[conversationRouteName].message.subscribe;\n    const subscribeOperation = customOpFactory(client, modelIntrospection, 'subscription', subscribeSchema, false, getInternals, getCustomUserAgentDetails(AiAction.OnMessage));\n    return subscribeOperation({ conversationId }).subscribe((data) => {\n        handler(convertItemToConversationMessage(data));\n    });\n};\n"],"names":[],"mappings":";;;;AAAA;AACA;AAIY,MAAC,uBAAuB,GAAG,CAAC,MAAM,EAAE,kBAAkB,EAAE,cAAc,EAAE,qBAAqB,EAAE,YAAY,KAAK,CAAC,OAAO,KAAK;AACzI,IAAI,MAAM,EAAE,aAAa,EAAE,GAAG,kBAAkB,CAAC;AACjD;AACA,IAAI,IAAI,CAAC,aAAa,EAAE;AACxB,QAAQ,OAAO,EAAE,CAAC;AAClB,KAAK;AACL,IAAI,MAAM,eAAe,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;AACnF,IAAI,MAAM,kBAAkB,GAAG,eAAe,CAAC,MAAM,EAAE,kBAAkB,EAAE,cAAc,EAAE,eAAe,EAAE,KAAK,EAAE,YAAY,EAAE,yBAAyB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;AAChL,IAAI,OAAO,kBAAkB,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,KAAK;AACtE,QAAQ,OAAO,CAAC,gCAAgC,CAAC,IAAI,CAAC,CAAC,CAAC;AACxD,KAAK,CAAC,CAAC;AACP;;;;"}