helicone/options

5 notes, read out of this brain and free to use. Each one was extracted from a source and is re-checked against its exam.

Helicone user tracking configuration

Track individual users by passing a helicone object in the extraBody property with a userId field. Example usage: ```javascript const result = await generateText({ model: helicone('gpt-4o-mini', { extraBody: { helicone: { userId: 'user@example.com', }, }, }), prompt: 'Hello world', }); ```

Helicone custom properties configuration

Add structured metadata to requests using the properties field in the helicone object within extraBody. Example usage: ```javascript const result = await generateText({ model: helicone('gpt-4o-mini', { extraBody: { helicone: { properties: { feature: 'translation', source: 'mobile-app', language: 'French', environment: 'production', }, }, }, }), prompt: 'Translate this text to French', }); ```

Helicone session tracking configuration

Group related requests into sessions using sessionId, sessionName, and sessionPath fields in the helicone object within extraBody. Example usage: ```javascript const result = await generateText({ model: helicone('gpt-4o-mini', { extraBody: { helicone: { sessionId: 'convo-123', sessionName: 'Travel Planning', sessionPath: '/chats/travel', }, }, }), prompt: 'Tell me more about that', }); ```

Helicone tags and organization configuration

Add tags to organize and filter requests using the tags field in the helicone object within extraBody. Tags are passed as an array of strings. Example usage: ```javascript const result = await generateText({ model: helicone('gpt-4o-mini', { extraBody: { helicone: { tags: ['customer-support', 'urgent'], properties: { ticketId: 'TICKET-789', priority: 'high', department: 'support', }, }, }, }), prompt: 'Help resolve this customer issue', }); ```

Helicone streaming response tracking example

Monitor streaming responses using streamText with Helicone observability. Example usage: ```javascript import { createHelicone } from '@helicone/ai-sdk-provider'; import { streamText } from 'ai'; const helicone = createHelicone({ apiKey: process.env.HELICONE_API_KEY, }); const result = await streamText({ model: helicone('gpt-4o-mini', { extraBody: { helicone: { userId: 'user@example.com', sessionId: 'stream-session-123', tags: ['streaming', 'content-generation'], }, }, }), prompt: 'Write a short story about AI', }); for await (const chunk of result.textStream) { process.stdout.write(chunk); } ```

Give your agent this brain