Merge pull request #1 from openshieldai/run

Run

Author: krichard1212

go.mod

@@ -1,3 +1,3 @@
-module github.com/sashabaranov/go-openai
+module github.com/openshieldai/go-openai
 
 go 1.18

run.go

@@ -28,16 +28,6 @@ type Run struct {
 	Metadata       map[string]any     `json:"metadata"`
 	Usage          Usage              `json:"usage,omitempty"`
 
-	Temperature *float32 `json:"temperature,omitempty"`
-	// The maximum number of prompt tokens that may be used over the course of the run.
-	// If the run exceeds the number of prompt tokens specified, the run will end with status 'incomplete'.
-	MaxPromptTokens int `json:"max_prompt_tokens,omitempty"`
-	// The maximum number of completion tokens that may be used over the course of the run.
-	// If the run exceeds the number of completion tokens specified, the run will end with status 'incomplete'.
-	MaxCompletionTokens int `json:"max_completion_tokens,omitempty"`
-	// ThreadTruncationStrategy defines the truncation strategy to use for the thread.
-	TruncationStrategy *ThreadTruncationStrategy `json:"truncation_strategy,omitempty"`
-
 	httpHeader
 }
 
@@ -50,7 +40,6 @@ const (
 	RunStatusCancelling     RunStatus = "cancelling"
 	RunStatusFailed         RunStatus = "failed"
 	RunStatusCompleted      RunStatus = "completed"
-	RunStatusIncomplete     RunStatus = "incomplete"
 	RunStatusExpired        RunStatus = "expired"
 	RunStatusCancelled      RunStatus = "cancelled"
 )
@@ -89,53 +78,7 @@ type RunRequest struct {
 	AdditionalInstructions string         `json:"additional_instructions,omitempty"`
 	Tools                  []Tool         `json:"tools,omitempty"`
 	Metadata               map[string]any `json:"metadata,omitempty"`
-
-	// Sampling temperature between 0 and 2. Higher values like 0.8 are  more random.
-	// lower values are more focused and deterministic.
-	Temperature *float32 `json:"temperature,omitempty"`
-	TopP        *float32 `json:"top_p,omitempty"`
-
-	// The maximum number of prompt tokens that may be used over the course of the run.
-	// If the run exceeds the number of prompt tokens specified, the run will end with status 'incomplete'.
-	MaxPromptTokens int `json:"max_prompt_tokens,omitempty"`
-
-	// The maximum number of completion tokens that may be used over the course of the run.
-	// If the run exceeds the number of completion tokens specified, the run will end with status 'incomplete'.
-	MaxCompletionTokens int `json:"max_completion_tokens,omitempty"`
-
-	// ThreadTruncationStrategy defines the truncation strategy to use for the thread.
-	TruncationStrategy *ThreadTruncationStrategy `json:"truncation_strategy,omitempty"`
-
-	// This can be either a string or a ToolChoice object.
-	ToolChoice any `json:"tool_choice,omitempty"`
-	// This can be either a string or a ResponseFormat object.
-	ResponseFormat any `json:"response_format,omitempty"`
-}
-
-// ThreadTruncationStrategy defines the truncation strategy to use for the thread.
-// https://platform.openai.com/docs/assistants/how-it-works/truncation-strategy.
-type ThreadTruncationStrategy struct {
-	// default 'auto'.
-	Type TruncationStrategy `json:"type,omitempty"`
-	// this field should be set if the truncation strategy is set to LastMessages.
-	LastMessages *int `json:"last_messages,omitempty"`
-}
-
-// TruncationStrategy defines the existing truncation strategies existing for thread management in an assistant.
-type TruncationStrategy string
-
-const (
-	// TruncationStrategyAuto messages in the middle of the thread will be dropped to fit the context length of the model.
-	TruncationStrategyAuto = TruncationStrategy("auto")
-	// TruncationStrategyLastMessages the thread will be truncated to the n most recent messages in the thread.
-	TruncationStrategyLastMessages = TruncationStrategy("last_messages")
-)
-
-// ReponseFormat specifies the format the model must output.
-// https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-response_format.
-// Type can either be text or json_object.
-type ReponseFormat struct {
-	Type string `json:"type"`
+	Stream                 bool           `json:"stream,omitempty"`
 }
 
 type RunModifyRequest struct {
@@ -240,7 +183,8 @@ func (c *Client) CreateRun(
 		http.MethodPost,
 		c.fullURL(urlSuffix),
 		withBody(request),
-		withBetaAssistantVersion(c.config.AssistantVersion))
+		withBetaAssistantVersion(c.config.AssistantVersion),
+	)
 	if err != nil {
 		return
 	}
@@ -249,6 +193,51 @@ func (c *Client) CreateRun(
 	return
 }
 
+type RunStreamResponseDelta struct {
+	Role    string           `json:"role"`
+	Content []MessageContent `json:"content"`
+	FileIDs []string         `json:"file_ids"`
+}
+
+type RunStreamResponse struct {
+	ID     string                 `json:"id"`
+	Object string                 `json:"object"`
+	Delta  RunStreamResponseDelta `json:"delta"`
+}
+
+type RunStream struct {
+	*streamReader[RunStreamResponse]
+}
+
+// CreateRunStream creates a new run with streaming support.
+func (c *Client) CreateRunStream(
+	ctx context.Context,
+	threadID string,
+	request RunRequest,
+) (stream *RunStream, err error) {
+	urlSuffix := fmt.Sprintf("/threads/%s/runs", threadID)
+	request.Stream = true
+	req, err := c.newRequest(
+		ctx,
+		http.MethodPost,
+		c.fullURL(urlSuffix),
+		withBody(request),
+		withBetaAssistantVersion(c.config.AssistantVersion),
+	)
+	if err != nil {
+		return
+	}
+
+	resp, err := sendRequestStream[RunStreamResponse](c, req)
+	if err != nil {
+		return
+	}
+	stream = &RunStream{
+		streamReader: resp,
+	}
+	return
+}
+
 // RetrieveRun retrieves a run.
 func (c *Client) RetrieveRun(
 	ctx context.Context,
@@ -260,7 +249,8 @@ func (c *Client) RetrieveRun(
 		ctx,
 		http.MethodGet,
 		c.fullURL(urlSuffix),
-		withBetaAssistantVersion(c.config.AssistantVersion))
+		withBetaAssistantVersion(c.config.AssistantVersion),
+	)
 	if err != nil {
 		return
 	}
@@ -282,7 +272,8 @@ func (c *Client) ModifyRun(
 		http.MethodPost,
 		c.fullURL(urlSuffix),
 		withBody(request),
-		withBetaAssistantVersion(c.config.AssistantVersion))
+		withBetaAssistantVersion(c.config.AssistantVersion),
+	)
 	if err != nil {
 		return
 	}
@@ -321,7 +312,8 @@ func (c *Client) ListRuns(
 		ctx,
 		http.MethodGet,
 		c.fullURL(urlSuffix),
-		withBetaAssistantVersion(c.config.AssistantVersion))
+		withBetaAssistantVersion(c.config.AssistantVersion),
+	)
 	if err != nil {
 		return
 	}
@@ -342,7 +334,8 @@ func (c *Client) SubmitToolOutputs(
 		http.MethodPost,
 		c.fullURL(urlSuffix),
 		withBody(request),
-		withBetaAssistantVersion(c.config.AssistantVersion))
+		withBetaAssistantVersion(c.config.AssistantVersion),
+	)
 	if err != nil {
 		return
 	}
@@ -361,7 +354,8 @@ func (c *Client) CancelRun(
 		ctx,
 		http.MethodPost,
 		c.fullURL(urlSuffix),
-		withBetaAssistantVersion(c.config.AssistantVersion))
+		withBetaAssistantVersion(c.config.AssistantVersion),
+	)
 	if err != nil {
 		return
 	}
@@ -380,7 +374,8 @@ func (c *Client) CreateThreadAndRun(
 		http.MethodPost,
 		c.fullURL(urlSuffix),
 		withBody(request),
-		withBetaAssistantVersion(c.config.AssistantVersion))
+		withBetaAssistantVersion(c.config.AssistantVersion),
+	)
 	if err != nil {
 		return
 	}
@@ -401,7 +396,8 @@ func (c *Client) RetrieveRunStep(
 		ctx,
 		http.MethodGet,
 		c.fullURL(urlSuffix),
-		withBetaAssistantVersion(c.config.AssistantVersion))
+		withBetaAssistantVersion(c.config.AssistantVersion),
+	)
 	if err != nil {
 		return
 	}
@@ -441,7 +437,8 @@ func (c *Client) ListRunSteps(
 		ctx,
 		http.MethodGet,
 		c.fullURL(urlSuffix),
-		withBetaAssistantVersion(c.config.AssistantVersion))
+		withBetaAssistantVersion(c.config.AssistantVersion),
+	)
 	if err != nil {
 		return
 	}

stream_reader.go

@@ -16,7 +16,7 @@ var (
 )
 
 type streamable interface {
-	ChatCompletionStreamResponse | CompletionResponse
+	ChatCompletionStreamResponse | CompletionResponse | RunStreamResponse
 }
 
 type streamReader[T streamable] struct {