Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
84 lines
3.7 KiB
Plaintext
84 lines
3.7 KiB
Plaintext
import { Span } from '../../types-hoist/span';
|
|
import { ChatCompletionChunk, InstrumentedMethod, OpenAiChatCompletionObject, OpenAIConversationObject, OpenAICreateEmbeddingsObject, OpenAIResponseObject, ResponseStreamingEvent } from './types';
|
|
/**
|
|
* Maps OpenAI method paths to OpenTelemetry semantic convention operation names
|
|
* @see https://opentelemetry.io/docs/specs/semconv/gen-ai/gen-ai-spans/#llm-request-spans
|
|
*/
|
|
export declare function getOperationName(methodPath: string): string;
|
|
/**
|
|
* Get the span operation for OpenAI methods
|
|
* Following Sentry's convention: "gen_ai.{operation_name}"
|
|
*/
|
|
export declare function getSpanOperation(methodPath: string): string;
|
|
/**
|
|
* Check if a method path should be instrumented
|
|
*/
|
|
export declare function shouldInstrument(methodPath: string): methodPath is InstrumentedMethod;
|
|
/**
|
|
* Build method path from current traversal
|
|
*/
|
|
export declare function buildMethodPath(currentPath: string, prop: string): string;
|
|
/**
|
|
* Check if response is a Chat Completion object
|
|
*/
|
|
export declare function isChatCompletionResponse(response: unknown): response is OpenAiChatCompletionObject;
|
|
/**
|
|
* Check if response is a Responses API object
|
|
*/
|
|
export declare function isResponsesApiResponse(response: unknown): response is OpenAIResponseObject;
|
|
/**
|
|
* Check if response is an Embeddings API object
|
|
*/
|
|
export declare function isEmbeddingsResponse(response: unknown): response is OpenAICreateEmbeddingsObject;
|
|
/**
|
|
* Check if response is a Conversations API object
|
|
* @see https://platform.openai.com/docs/api-reference/conversations
|
|
*/
|
|
export declare function isConversationResponse(response: unknown): response is OpenAIConversationObject;
|
|
/**
|
|
* Check if streaming event is from the Responses API
|
|
*/
|
|
export declare function isResponsesApiStreamEvent(event: unknown): event is ResponseStreamingEvent;
|
|
/**
|
|
* Check if streaming event is a chat completion chunk
|
|
*/
|
|
export declare function isChatCompletionChunk(event: unknown): event is ChatCompletionChunk;
|
|
/**
|
|
* Add attributes for Chat Completion responses
|
|
*/
|
|
export declare function addChatCompletionAttributes(span: Span, response: OpenAiChatCompletionObject, recordOutputs?: boolean): void;
|
|
/**
|
|
* Add attributes for Responses API responses
|
|
*/
|
|
export declare function addResponsesApiAttributes(span: Span, response: OpenAIResponseObject, recordOutputs?: boolean): void;
|
|
/**
|
|
* Add attributes for Embeddings API responses
|
|
*/
|
|
export declare function addEmbeddingsAttributes(span: Span, response: OpenAICreateEmbeddingsObject): void;
|
|
/**
|
|
* Add attributes for Conversations API responses
|
|
* @see https://platform.openai.com/docs/api-reference/conversations
|
|
*/
|
|
export declare function addConversationAttributes(span: Span, response: OpenAIConversationObject): void;
|
|
/**
|
|
* Set token usage attributes
|
|
* @param span - The span to add attributes to
|
|
* @param promptTokens - The number of prompt tokens
|
|
* @param completionTokens - The number of completion tokens
|
|
* @param totalTokens - The number of total tokens
|
|
*/
|
|
export declare function setTokenUsageAttributes(span: Span, promptTokens?: number, completionTokens?: number, totalTokens?: number): void;
|
|
/**
|
|
* Set common response attributes
|
|
* @param span - The span to add attributes to
|
|
* @param id - The response id
|
|
* @param model - The response model
|
|
* @param timestamp - The response timestamp
|
|
*/
|
|
export declare function setCommonResponseAttributes(span: Span, id: string, model: string, timestamp: number): void;
|
|
/**
|
|
* Extract request parameters including model settings and conversation context
|
|
*/
|
|
export declare function extractRequestParameters(params: Record<string, unknown>): Record<string, unknown>;
|
|
//# sourceMappingURL=utils.d.ts.map
|