feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 42
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai%2Ftogetherai-eee41ccf2ac9eb601853ae1d06a9c9f92b13aa4dc7a588117c41032490d69b2d.yml
-openapi_spec_hash: c5bf431d30ef57c992ef0200f6396acd
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai%2Ftogetherai-03d7fa44ead3c37be5cc4140d7273b836bc5a072a9d8c800425f5885f2f26899.yml
+openapi_spec_hash: 9538969b09ef333a046cf66c21187b11
 config_hash: 50b86276412e927f8eb0e69e2857b1c7

api.md

@@ -278,5 +278,5 @@ Methods:
 
 - <code title="get /evaluation/{id}">client.Evals.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#EvalService.Get">Get</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, id <a href="https://pkg.go.dev/builtin#string">string</a>) (<a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#EvalGetResponse">EvalGetResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 - <code title="get /evaluations">client.Evals.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#EvalService.List">List</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, query <a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#EvalListParams">EvalListParams</a>) ([]<a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#EvalListResponse">EvalListResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
-- <code title="get /evaluations/model-list">client.Evals.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#EvalService.GetAllowedModels">GetAllowedModels</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>) (<a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#EvalGetAllowedModelsResponse">EvalGetAllowedModelsResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
+- <code title="get /evaluations/model-list">client.Evals.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#EvalService.GetAllowedModels">GetAllowedModels</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, query <a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#EvalGetAllowedModelsParams">EvalGetAllowedModelsParams</a>) (<a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#EvalGetAllowedModelsResponse">EvalGetAllowedModelsResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 - <code title="get /evaluation/{id}/status">client.Evals.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#EvalService.GetStatus">GetStatus</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, id <a href="https://pkg.go.dev/builtin#string">string</a>) (<a href="https://pkg.go.dev/github.com/togethercomputer/together-go">together</a>.<a href="https://pkg.go.dev/github.com/togethercomputer/together-go#EvalGetStatusResponse">EvalGetStatusResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>

eval.go

@@ -39,7 +39,7 @@ func NewEvalService(opts ...option.RequestOption) (r EvalService) {
 	return
 }
 
-// Get details of a specific evaluation job
+// Get evaluation job details
 func (r *EvalService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *EvalGetResponse, err error) {
 	opts = slices.Concat(r.Options, opts)
 	if id == "" {
@@ -51,23 +51,23 @@ func (r *EvalService) Get(ctx context.Context, id string, opts ...option.Request
 	return
 }
 
-// Get a list of evaluation jobs with optional filtering
+// Get all evaluation jobs. Deprecated! Please use /evaluation
 func (r *EvalService) List(ctx context.Context, query EvalListParams, opts ...option.RequestOption) (res *[]EvalListResponse, err error) {
 	opts = slices.Concat(r.Options, opts)
 	path := "evaluations"
 	err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &res, opts...)
 	return
 }
 
-// Get the list of models that are allowed for evaluation
-func (r *EvalService) GetAllowedModels(ctx context.Context, opts ...option.RequestOption) (res *EvalGetAllowedModelsResponse, err error) {
+// Get model list
+func (r *EvalService) GetAllowedModels(ctx context.Context, query EvalGetAllowedModelsParams, opts ...option.RequestOption) (res *EvalGetAllowedModelsResponse, err error) {
 	opts = slices.Concat(r.Options, opts)
 	path := "evaluations/model-list"
-	err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...)
+	err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &res, opts...)
 	return
 }
 
-// Get the status and results of a specific evaluation job
+// Get evaluation job status and results
 func (r *EvalService) GetStatus(ctx context.Context, id string, opts ...option.RequestOption) (res *EvalGetStatusResponse, err error) {
 	opts = slices.Concat(r.Options, opts)
 	if id == "" {
@@ -703,8 +703,11 @@ func (r *EvalGetAllowedModelsResponse) UnmarshalJSON(data []byte) error {
 }
 
 type EvalGetStatusResponse struct {
-	Results EvalGetStatusResponseResultsUnion `json:"results,nullable"`
-	// Any of "pending", "queued", "running", "completed", "error", "user_error".
+	// The results of the evaluation job
+	Results EvalGetStatusResponseResultsUnion `json:"results"`
+	// The status of the evaluation job
+	//
+	// Any of "completed", "error", "user_error", "running", "queued", "pending".
 	Status EvalGetStatusResponseStatus `json:"status"`
 	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
 	JSON struct {
@@ -724,8 +727,7 @@ func (r *EvalGetStatusResponse) UnmarshalJSON(data []byte) error {
 // EvalGetStatusResponseResultsUnion contains all possible properties and values
 // from [EvalGetStatusResponseResultsEvaluationClassifyResults],
 // [EvalGetStatusResponseResultsEvaluationScoreResults],
-// [EvalGetStatusResponseResultsEvaluationCompareResults],
-// [EvalGetStatusResponseResultsError].
+// [EvalGetStatusResponseResultsEvaluationCompareResults].
 //
 // Use the methods beginning with 'As' to cast the union to one of its variants.
 type EvalGetStatusResponseResultsUnion struct {
@@ -759,9 +761,7 @@ type EvalGetStatusResponseResultsUnion struct {
 	// This field is from variant
 	// [EvalGetStatusResponseResultsEvaluationCompareResults].
 	Ties int64 `json:"Ties"`
-	// This field is from variant [EvalGetStatusResponseResultsError].
-	Error string `json:"error"`
-	JSON  struct {
+	JSON struct {
 		GenerationFailCount respjson.Field
 		InvalidLabelCount   respjson.Field
 		JudgeFailCount      respjson.Field
@@ -775,7 +775,6 @@ type EvalGetStatusResponseResultsUnion struct {
 		BWins               respjson.Field
 		NumSamples          respjson.Field
 		Ties                respjson.Field
-		Error               respjson.Field
 		raw                 string
 	} `json:"-"`
 }
@@ -795,11 +794,6 @@ func (u EvalGetStatusResponseResultsUnion) AsEvalGetStatusResponseResultsEvaluat
 	return
 }
 
-func (u EvalGetStatusResponseResultsUnion) AsEvalGetStatusResponseResultsError() (v EvalGetStatusResponseResultsError) {
-	apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
-	return
-}
-
 // Returns the unmodified JSON received from the API
 func (u EvalGetStatusResponseResultsUnion) RawJSON() string { return u.JSON.raw }
 
@@ -927,40 +921,24 @@ func (r *EvalGetStatusResponseResultsEvaluationCompareResults) UnmarshalJSON(dat
 	return apijson.UnmarshalRoot(data, r)
 }
 
-type EvalGetStatusResponseResultsError struct {
-	Error string `json:"error"`
-	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
-	JSON struct {
-		Error       respjson.Field
-		ExtraFields map[string]respjson.Field
-		raw         string
-	} `json:"-"`
-}
-
-// Returns the unmodified JSON received from the API
-func (r EvalGetStatusResponseResultsError) RawJSON() string { return r.JSON.raw }
-func (r *EvalGetStatusResponseResultsError) UnmarshalJSON(data []byte) error {
-	return apijson.UnmarshalRoot(data, r)
-}
-
+// The status of the evaluation job
 type EvalGetStatusResponseStatus string
 
 const (
-	EvalGetStatusResponseStatusPending   EvalGetStatusResponseStatus = "pending"
-	EvalGetStatusResponseStatusQueued    EvalGetStatusResponseStatus = "queued"
-	EvalGetStatusResponseStatusRunning   EvalGetStatusResponseStatus = "running"
 	EvalGetStatusResponseStatusCompleted EvalGetStatusResponseStatus = "completed"
 	EvalGetStatusResponseStatusError     EvalGetStatusResponseStatus = "error"
 	EvalGetStatusResponseStatusUserError EvalGetStatusResponseStatus = "user_error"
+	EvalGetStatusResponseStatusRunning   EvalGetStatusResponseStatus = "running"
+	EvalGetStatusResponseStatusQueued    EvalGetStatusResponseStatus = "queued"
+	EvalGetStatusResponseStatusPending   EvalGetStatusResponseStatus = "pending"
 )
 
 type EvalListParams struct {
-	// Maximum number of results to return (max 100)
-	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
-	// Filter by job status
-	//
-	// Any of "pending", "queued", "running", "completed", "error", "user_error".
-	Status EvalListParamsStatus `query:"status,omitzero" json:"-"`
+	Limit  param.Opt[int64]  `query:"limit,omitzero" json:"-"`
+	Status param.Opt[string] `query:"status,omitzero" json:"-"`
+	// Admin users can specify a user ID to filter jobs. Pass empty string to get all
+	// jobs.
+	UserID param.Opt[string] `query:"userId,omitzero" json:"-"`
 	paramObj
 }
 
@@ -972,14 +950,16 @@ func (r EvalListParams) URLQuery() (v url.Values, err error) {
 	})
 }
 
-// Filter by job status
-type EvalListParamsStatus string
+type EvalGetAllowedModelsParams struct {
+	ModelSource param.Opt[string] `query:"model_source,omitzero" json:"-"`
+	paramObj
+}
 
-const (
-	EvalListParamsStatusPending   EvalListParamsStatus = "pending"
-	EvalListParamsStatusQueued    EvalListParamsStatus = "queued"
-	EvalListParamsStatusRunning   EvalListParamsStatus = "running"
-	EvalListParamsStatusCompleted EvalListParamsStatus = "completed"
-	EvalListParamsStatusError     EvalListParamsStatus = "error"
-	EvalListParamsStatusUserError EvalListParamsStatus = "user_error"
-)
+// URLQuery serializes [EvalGetAllowedModelsParams]'s query parameters as
+// `url.Values`.
+func (r EvalGetAllowedModelsParams) URLQuery() (v url.Values, err error) {
+	return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
+		ArrayFormat:  apiquery.ArrayQueryFormatComma,
+		NestedFormat: apiquery.NestedQueryFormatBrackets,
+	})
+}

eval_test.go

@@ -48,8 +48,9 @@ func TestEvalListWithOptionalParams(t *testing.T) {
 		option.WithAPIKey("My API Key"),
 	)
 	_, err := client.Evals.List(context.TODO(), together.EvalListParams{
-		Limit:  together.Int(1),
-		Status: together.EvalListParamsStatusPending,
+		Limit:  together.Int(0),
+		Status: together.String("status"),
+		UserID: together.String("userId"),
 	})
 	if err != nil {
 		var apierr *together.Error
@@ -60,7 +61,7 @@ func TestEvalListWithOptionalParams(t *testing.T) {
 	}
 }
 
-func TestEvalGetAllowedModels(t *testing.T) {
+func TestEvalGetAllowedModelsWithOptionalParams(t *testing.T) {
 	baseURL := "http://localhost:4010"
 	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
 		baseURL = envURL
@@ -72,7 +73,9 @@ func TestEvalGetAllowedModels(t *testing.T) {
 		option.WithBaseURL(baseURL),
 		option.WithAPIKey("My API Key"),
 	)
-	_, err := client.Evals.GetAllowedModels(context.TODO())
+	_, err := client.Evals.GetAllowedModels(context.TODO(), together.EvalGetAllowedModelsParams{
+		ModelSource: together.String("model_source"),
+	})
 	if err != nil {
 		var apierr *together.Error
 		if errors.As(err, &apierr) {