chat_stream.go

package openai

import (
"context"
"net/http"
)

typeChatCompletionStreamChoiceDeltastruct {
Contentstring`json:"content,omitempty"`
Rolestring`json:"role,omitempty"`
FunctionCall*FunctionCall`json:"function_call,omitempty"`
ToolCalls []ToolCall`json:"tool_calls,omitempty"`
Refusalstring`json:"refusal,omitempty"`
}

typeChatCompletionStreamChoiceLogprobsstruct {
Content []ChatCompletionTokenLogprob`json:"content,omitempty"`
Refusal []ChatCompletionTokenLogprob`json:"refusal,omitempty"`
}

typeChatCompletionTokenLogprobstruct {
Tokenstring`json:"token"`
Bytes []int64`json:"bytes,omitempty"`
Logprobfloat64`json:"logprob,omitempty"`
TopLogprobs []ChatCompletionTokenLogprobTopLogprob`json:"top_logprobs"`
}

typeChatCompletionTokenLogprobTopLogprobstruct {
Tokenstring`json:"token"`
Bytes []int64`json:"bytes"`
Logprobfloat64`json:"logprob"`
}

typeChatCompletionStreamChoicestruct {
Indexint`json:"index"`
DeltaChatCompletionStreamChoiceDelta`json:"delta"`
Logprobs*ChatCompletionStreamChoiceLogprobs`json:"logprobs,omitempty"`
FinishReasonFinishReason`json:"finish_reason"`
ContentFilterResultsContentFilterResults`json:"content_filter_results,omitempty"`
}

typePromptFilterResultstruct {
Indexint`json:"index"`
ContentFilterResultsContentFilterResults`json:"content_filter_results,omitempty"`
}

typeChatCompletionStreamResponsestruct {
IDstring`json:"id"`
Objectstring`json:"object"`
Createdint64`json:"created"`
Modelstring`json:"model"`
Choices []ChatCompletionStreamChoice`json:"choices"`
SystemFingerprintstring`json:"system_fingerprint"`
PromptAnnotations []PromptAnnotation`json:"prompt_annotations,omitempty"`
PromptFilterResults []PromptFilterResult`json:"prompt_filter_results,omitempty"`
// An optional field that will only be present when you set stream_options: {"include_usage": true} in your request.
// When present, it contains a null value except for the last chunk which contains the token usage statistics
// for the entire request.
Usage*Usage`json:"usage,omitempty"`
}

// ChatCompletionStream
// Note: Perhaps it is more elegant to abstract Stream using generics.
typeChatCompletionStreamstruct {
*streamReader[ChatCompletionStreamResponse]
}

// CreateChatCompletionStream — API call to create a chat completion w/ streaming
// support. It sets whether to stream back partial progress. If set, tokens will be
// sent as data-only server-sent events as they become available, with the
// stream terminated by a data: [DONE] message.
func (c*Client) CreateChatCompletionStream(
ctx context.Context,
requestChatCompletionRequest,
) (stream*ChatCompletionStream, errerror) {
urlSuffix:=chatCompletionsSuffix
if!checkEndpointSupportsModel(urlSuffix, request.Model) {
err=ErrChatCompletionInvalidModel
return
 }

request.Stream=true
reasoningValidator:=NewReasoningValidator()
iferr=reasoningValidator.Validate(request); err!=nil {
return
 }

req, err:=c.newRequest(
ctx,
http.MethodPost,
c.fullURL(urlSuffix, withModel(request.Model)),
withBody(request),
 )
iferr!=nil {
returnnil, err
 }

resp, err:=sendRequestStream[ChatCompletionStreamResponse](c, req)
iferr!=nil {
return
 }
stream=&ChatCompletionStream{
streamReader: resp,
 }
return
}