chore(closes OPEN-8647): add endpoint to retrieve aggregated user data for inference pipelines

Author: stainless-app[bot]

.stats.yml

@@ -1,3 +1,3 @@
-configured_endpoints: 26
-openapi_spec_hash: 6f6cb98b7755d18274dd51e857508336
-config_hash: cc9a32249c08143687799eb8de187d6a
+configured_endpoints: 27
+openapi_spec_hash: c70c3eccfe803e99c14e97e650b1e314
+config_hash: 1f7626e569e1a74574a58d7883170a0e

api.md

@@ -109,12 +109,14 @@ Response Types:
 
 - <a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go">openlayer</a>.<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go#InferencePipelineGetResponse">InferencePipelineGetResponse</a>
 - <a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go">openlayer</a>.<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go#InferencePipelineUpdateResponse">InferencePipelineUpdateResponse</a>
+- <a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go">openlayer</a>.<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go#InferencePipelineGetUsersResponse">InferencePipelineGetUsersResponse</a>
 
 Methods:
 
 - <code title="get /inference-pipelines/{inferencePipelineId}">client.InferencePipelines.<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go#InferencePipelineService.Get">Get</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, inferencePipelineID <a href="https://pkg.go.dev/builtin#string">string</a>, query <a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go">openlayer</a>.<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go#InferencePipelineGetParams">InferencePipelineGetParams</a>) (\*<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go">openlayer</a>.<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go#InferencePipelineGetResponse">InferencePipelineGetResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 - <code title="put /inference-pipelines/{inferencePipelineId}">client.InferencePipelines.<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go#InferencePipelineService.Update">Update</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, inferencePipelineID <a href="https://pkg.go.dev/builtin#string">string</a>, body <a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go">openlayer</a>.<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go#InferencePipelineUpdateParams">InferencePipelineUpdateParams</a>) (\*<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go">openlayer</a>.<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go#InferencePipelineUpdateResponse">InferencePipelineUpdateResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 - <code title="delete /inference-pipelines/{inferencePipelineId}">client.InferencePipelines.<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go#InferencePipelineService.Delete">Delete</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, inferencePipelineID <a href="https://pkg.go.dev/builtin#string">string</a>) <a href="https://pkg.go.dev/builtin#error">error</a></code>
+- <code title="get /inference-pipelines/{inferencePipelineId}/users">client.InferencePipelines.<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go#InferencePipelineService.GetUsers">GetUsers</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, inferencePipelineID <a href="https://pkg.go.dev/builtin#string">string</a>, query <a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go">openlayer</a>.<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go#InferencePipelineGetUsersParams">InferencePipelineGetUsersParams</a>) (\*<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go">openlayer</a>.<a href="https://pkg.go.dev/github.com/openlayer-ai/openlayer-go#InferencePipelineGetUsersResponse">InferencePipelineGetUsersResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 
 ## Data
 

inferencepipeline.go

@@ -82,6 +82,22 @@ func (r *InferencePipelineService) Delete(ctx context.Context, inferencePipeline
 	return
 }
 
+// Get aggregated user data for an inference pipeline with pagination and metadata.
+//
+// Returns a list of users who have interacted with the inference pipeline,
+// including their activity statistics such as session counts, record counts, token
+// usage, and costs.
+func (r *InferencePipelineService) GetUsers(ctx context.Context, inferencePipelineID string, query InferencePipelineGetUsersParams, opts ...option.RequestOption) (res *InferencePipelineGetUsersResponse, err error) {
+	opts = slices.Concat(r.Options, opts)
+	if inferencePipelineID == "" {
+		err = errors.New("missing required inferencePipelineId parameter")
+		return
+	}
+	path := fmt.Sprintf("inference-pipelines/%s/users", inferencePipelineID)
+	err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &res, opts...)
+	return
+}
+
 type InferencePipelineGetResponse struct {
 	// The inference pipeline id.
 	ID string `json:"id,required" format:"uuid"`
@@ -2075,6 +2091,68 @@ func (r inferencePipelineUpdateResponseWorkspaceMonthlyUsageJSON) RawJSON() stri
 	return r.raw
 }
 
+type InferencePipelineGetUsersResponse struct {
+	// Array of user aggregation data
+	Items []InferencePipelineGetUsersResponseItem `json:"items,required"`
+	JSON  inferencePipelineGetUsersResponseJSON   `json:"-"`
+}
+
+// inferencePipelineGetUsersResponseJSON contains the JSON metadata for the struct
+// [InferencePipelineGetUsersResponse]
+type inferencePipelineGetUsersResponseJSON struct {
+	Items       apijson.Field
+	raw         string
+	ExtraFields map[string]apijson.Field
+}
+
+func (r *InferencePipelineGetUsersResponse) UnmarshalJSON(data []byte) (err error) {
+	return apijson.UnmarshalRoot(data, r)
+}
+
+func (r inferencePipelineGetUsersResponseJSON) RawJSON() string {
+	return r.raw
+}
+
+type InferencePipelineGetUsersResponseItem struct {
+	// The unique user identifier
+	ID string `json:"id,required"`
+	// Total cost for this user
+	Cost float64 `json:"cost,required"`
+	// Timestamp of the user's first event/trace
+	DateOfFirstRecord time.Time `json:"dateOfFirstRecord,required" format:"date-time"`
+	// Timestamp of the user's last event/trace
+	DateOfLastRecord time.Time `json:"dateOfLastRecord,required" format:"date-time"`
+	// Total number of traces/rows for this user
+	Records int64 `json:"records,required"`
+	// Count of unique sessions for this user
+	Sessions int64 `json:"sessions,required"`
+	// Total token count for this user
+	Tokens float64                                   `json:"tokens,required"`
+	JSON   inferencePipelineGetUsersResponseItemJSON `json:"-"`
+}
+
+// inferencePipelineGetUsersResponseItemJSON contains the JSON metadata for the
+// struct [InferencePipelineGetUsersResponseItem]
+type inferencePipelineGetUsersResponseItemJSON struct {
+	ID                apijson.Field
+	Cost              apijson.Field
+	DateOfFirstRecord apijson.Field
+	DateOfLastRecord  apijson.Field
+	Records           apijson.Field
+	Sessions          apijson.Field
+	Tokens            apijson.Field
+	raw               string
+	ExtraFields       map[string]apijson.Field
+}
+
+func (r *InferencePipelineGetUsersResponseItem) UnmarshalJSON(data []byte) (err error) {
+	return apijson.UnmarshalRoot(data, r)
+}
+
+func (r inferencePipelineGetUsersResponseItemJSON) RawJSON() string {
+	return r.raw
+}
+
 type InferencePipelineGetParams struct {
 	// Expand specific nested objects.
 	Expand param.Field[[]InferencePipelineGetParamsExpand] `query:"expand"`
@@ -2117,3 +2195,19 @@ type InferencePipelineUpdateParams struct {
 func (r InferencePipelineUpdateParams) MarshalJSON() (data []byte, err error) {
 	return apijson.MarshalRoot(r)
 }
+
+type InferencePipelineGetUsersParams struct {
+	// The page to return in a paginated query.
+	Page param.Field[int64] `query:"page"`
+	// Maximum number of items to return per page.
+	PerPage param.Field[int64] `query:"perPage"`
+}
+
+// URLQuery serializes [InferencePipelineGetUsersParams]'s query parameters as
+// `url.Values`.
+func (r InferencePipelineGetUsersParams) URLQuery() (v url.Values) {
+	return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
+		ArrayFormat:  apiquery.ArrayQueryFormatComma,
+		NestedFormat: apiquery.NestedQueryFormatBrackets,
+	})
+}

inferencepipeline_test.go

@@ -92,3 +92,32 @@ func TestInferencePipelineDelete(t *testing.T) {
 		t.Fatalf("err should be nil: %s", err.Error())
 	}
 }
+
+func TestInferencePipelineGetUsersWithOptionalParams(t *testing.T) {
+	baseURL := "http://localhost:4010"
+	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
+		baseURL = envURL
+	}
+	if !testutil.CheckTestServer(t, baseURL) {
+		return
+	}
+	client := openlayer.NewClient(
+		option.WithBaseURL(baseURL),
+		option.WithAPIKey("My API Key"),
+	)
+	_, err := client.InferencePipelines.GetUsers(
+		context.TODO(),
+		"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+		openlayer.InferencePipelineGetUsersParams{
+			Page:    openlayer.F(int64(1)),
+			PerPage: openlayer.F(int64(1)),
+		},
+	)
+	if err != nil {
+		var apierr *openlayer.Error
+		if errors.As(err, &apierr) {
+			t.Log(string(apierr.DumpRequest(true)))
+		}
+		t.Fatalf("err should be nil: %s", err.Error())
+	}
+}