Vue 3 Composables

YH-UI provides multiple Vue 3 Composition API Hooks to simplify AI functionality in Vue.

createStreamableValue - Streaming Values

Create reactive values that can be progressively updated during streaming, enabling typewriter effects in UI.

import { createStreamableValue, useStreamableValue } from '@yh-ui/ai-sdk'

// Create streaming value
const streamable = createStreamableValue<string>('')

// Use in component
const { value, loading, error } = useStreamableValue(streamable)

// Update in streaming callback
streamable.value.value = 'Hello '
streamable.value.value += 'World'
streamable.loading.value = false

API

Property/Method	Type	Description
createStreamableValue(initial)	Function	Create streaming value
value.value	Ref<string>	Currently accumulated text
loading.value	Ref<boolean>	Loading state
error.value	Ref<Error | null>	Error information

useConversation - Conversation History

Manage conversation message list with support for adding, clearing, and persistence.

import { useConversation } from '@yh-ui/ai-sdk'

const { messages, addMessage, clearHistory, setMessages } = useConversation({
  maxHistory: 50, // Maximum history count
  persist: true, // Persist to localStorage
  storageKey: 'ai-conversation' // Storage key name
})

// Add messages
addMessage({ role: 'user', content: 'Hello' })
addMessage({ role: 'assistant', content: 'How can I help you?' })

// Clear history
clearHistory()

// Manually set messages
setMessages([{ role: 'user', content: 'Hello' }])

API

Property/Method	Type	Description
messages	Ref<ConversationMessage[]>	Message list
addMessage(msg)	Function	Add message
clearHistory()	Function	Clear history
setMessages(msgs)	Function	Set messages

createAIContext - AI Context

Provide session ID, model configuration, and other context at the root of the application. Child components access via inject.

import { createAIContext } from '@yh-ui/ai-sdk'

// Root component
const aiContext = createAIContext(
  { name: 'openai', defaultModel: 'gpt-4' },
  { sessionId: 'user-session-123' }
)

// Provide to child components
provide('ai-context', aiContext)

// In child component
import { inject } from 'vue'

const context = inject('ai-context')

// Get/set model configuration
console.log(context.modelConfig.value) // { model: 'gpt-4', ... }
context.setModel({ model: 'gpt-4o', temperature: 0.8 })

// Session ID
console.log(context.sessionId) // 'user-session-123'

useAIChat - AI Chat Hook (Enhanced)

Manage AI chat state with support for streaming, tool calling, local fallback on error, and message resend/recovery.

import { useAIChat } from '@yh-ui/ai-sdk'

const {
  messages,
  input,
  isLoading,
  error,
  sendMessage,
  resend // Resend the last user message
} = useAIChat({
  api: '/api/chat',
  enableFallback: true, // Enable local fallback when backend is unavailable
  fallbackContent: 'Sorry, the system is temporarily unavailable. Please try again later.' // Custom fallback text
})

API

Property/Method	Type	Description
enableFallback	boolean	Whether to enable local fallback content (default: false)
fallbackContent	string	Local fallback reply text (default: '抱歉，服务暂时不可用，请稍后再试。')
resend()	() => Promise<void>	Discards the last failed reply/messages and resends the last user input

Integration with YH-UI Components

@yh-ui/ai-sdk can work with YH-UI AI components (such as yh-ai-bubble):

<script setup lang="ts">
import { useAIChat } from '@yh-ui/ai-sdk'

const { messages, input, isLoading, sendMessage } = useAIChat({
  api: '/api/chat'
})
</script>

<template>
  <div class="chat-container">
    <yh-ai-bubble v-for="msg in messages" :key="msg.id" :role="msg.role" :content="msg.content" />
    <div class="input-area">
      <yh-input v-model="input" @pressEnter="sendMessage(input)" />
      <yh-button :loading="isLoading" @click="sendMessage(input)">Send</yh-button>
    </div>
  </div>
</template>

TIP

useAIChat and useConversation can be used together: useAIChat manages streaming requests, while useConversation manages message persistence.