--- title: useCompletion description: API reference for the useCompletion hook. --- # `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 ## API Signature ### Parameters void', description: 'An optional callback function that is called when the completion stream ends.', }, { name: 'onError', type: '(error: Error) => void', description: 'An optional callback that will be called when the chat stream encounters an error.', }, { name: 'headers', type: 'Record | Headers', description: 'An optional object of headers to be passed to the API endpoint.', }, { name: 'body', type: 'any', description: 'An optional, additional body object to be passed to the API endpoint.', }, { name: 'credentials', type: "'omit' | 'same-origin' | 'include'", description: 'An optional literal that sets the mode of credentials to be used on the request. Defaults to same-origin.', }, { name: 'streamProtocol', type: "'text' | 'data'", isOptional: true, description: 'An optional literal that sets the type of stream to be used. Defaults to `data`. If set to `text`, the stream will be treated as a text stream.', }, { name: 'fetch', type: 'FetchFunction', isOptional: true, description: 'Optional. A custom fetch function to be used for the API call. Defaults to the global fetch function.', }, { name: 'experimental_throttle', type: 'number', isOptional: true, description: 'React only. Custom throttle wait time in milliseconds for the completion and data updates. When specified, throttles how often the UI updates during streaming. Default is undefined, which disables throttling.', }, ]} /> ### Returns void', description: 'Function to execute text completion based on the provided prompt.', }, { name: 'error', type: 'undefined | Error', description: 'The error thrown during the completion process, if any.', }, { name: 'setCompletion', type: '(completion: string) => void', description: 'Function to update the `completion` state.', }, { name: 'stop', type: '() => void', description: 'Function to abort the current API request.', }, { name: 'input', type: 'string', description: 'The current value of the input field.', }, { name: 'setInput', type: 'React.Dispatch>', description: 'The current value of the input field.', }, { name: 'handleInputChange', type: '(event: any) => void', description: "Handler for the `onChange` event of the input field to control the input's value.", }, { name: 'handleSubmit', type: '(event?: { preventDefault?: () => void }) => void', description: 'Form submission handler that automatically resets the input field and appends a user message.', }, { name: 'isLoading', type: 'boolean', description: 'Boolean flag indicating whether a fetch operation is currently in progress.', }, ]} />