/** * @module teams-ai */ /** * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ import { ActionCall } from '../types'; /** * A message object sent to or received from an LLM. * @param TContent Optional. Type of the message content. Defaults to `string` */ export interface Message { /** * The messages role. Typically 'system', 'user', 'assistant', 'tool', 'function'. */ role: string; /** * Text of the message. */ content: TContent | undefined; /** * Optional. A named function to call. */ function_call?: FunctionCall; /** * The context used for the message. */ context?: MessageContext; /** * Optional. Name of the function that was called. */ name?: string; /** * Optional. The action or tool to be called by the model when using 'tools' augmentation. In OpenAI, this is the tool_calls property returned from the model. */ action_calls?: ActionCall[]; /** * Optional. The id of the action called. */ action_call_id?: string | undefined; } /** * A named function to call. */ export interface FunctionCall { /** * Name of the function to call. */ name?: string; /** * Optional. Arguments to pass to the function. Must be deserialized. */ arguments?: string; } export type MessageContentParts = TextContentPart | ImageContentPart; export interface TextContentPart { /** * Type of the message content. Should always be 'text'. */ type: 'text'; /** * The text of the message. */ text: string; } export interface ImageContentPart { /** * Type of the message content. Should always be 'image_url'. */ type: 'image_url'; /** * The URL of the image. */ image_url: string | { url: string; }; } /** * Citations returned by the model. */ export interface Citation { /** * The content of the citation. */ content: string; /** * The title of the citation. */ title: string | null; /** * The URL of the citation. */ url: string | null; /** * The filepath of the document. */ filepath: string | null; } export interface MessageContext { /** * Citations used in the message. */ citations: Citation[]; /** * The intent of the message (what the user wrote). */ intent: string; } //# sourceMappingURL=Message.d.ts.map