AI SDK UIuseCompletion
useCompletion()
Allows you to create text completion based capabilities for your application. It enables the streaming of text completions from your AI provider, manages the state for chat input, and updates the UI automatically as new messages are received.
Import
import { useCompletion } from 'ai/react'
API Signature
Parameters
api:
The text completion API endpoint offered by the provider.
id:
An unique identifier for the completion. If not provided, a random one will be generated. When provided, the `useCompletion` hook with the same `id` will have shared states across components. This is useful when you have multiple components showing the same chat stream
initialInput:
An optional string for the initial prompt input.
initialCompletion:
An optional string for the initial completion result.
onResponse:
An optional callback function that is called with the response from the API endpoint. Useful for throwing customized errors or logging.
onFinish:
An optional callback function that is called when the completion stream ends.
onError:
An optional callback that will be called when the chat stream encounters an error.
headers:
An optional object of headers to be passed to the API endpoint.
body:
An optional, additional body object to be passed to the API endpoint.
credentials:
An optional literal that sets the mode of credentials to be used on the request. Defaults to same-origin.
sendExtraMessageFields:
An optional boolean that determines whether to send extra fields you've added to `messages`. Defaults to `false` and only the `content` and `role` fields will be sent to the API endpoint.
streamMode:
An optional literal that sets the mode of the stream to be used. Defaults to `stream-data`. If set to `text`, the stream will be treated as a text stream.
fetch:
Optional. A custom fetch function to be used for the API call. Defaults to the global fetch function.
Returns
completion:
The current text completion.
complete:
Function to execute text completion based on the provided prompt.
error:
The error thrown during the completion process, if any.
setCompletion:
Function to update the `completion` state.
stop:
Function to abort the current API request.
input:
The current value of the input field.
setInput:
The current value of the input field.
handleInputChange:
Handler for the `onChange` event of the input field to control the input's value.
handleSubmit:
Form submission handler that automatically resets the input field and appends a user message.
isLoading:
Boolean flag indicating whether a fetch operation is currently in progress.