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

lib/openlayer.rb

@@ -59,6 +59,8 @@
 require_relative "openlayer/models/inference_pipeline_delete_params"
 require_relative "openlayer/models/inference_pipeline_retrieve_params"
 require_relative "openlayer/models/inference_pipeline_retrieve_response"
+require_relative "openlayer/models/inference_pipeline_retrieve_users_params"
+require_relative "openlayer/models/inference_pipeline_retrieve_users_response"
 require_relative "openlayer/models/inference_pipelines/data_stream_params"
 require_relative "openlayer/models/inference_pipelines/data_stream_response"
 require_relative "openlayer/models/inference_pipelines/row_update_params"

lib/openlayer/models.rb

@@ -47,6 +47,8 @@ module Openlayer
 
   InferencePipelineRetrieveParams = Openlayer::Models::InferencePipelineRetrieveParams
 
+  InferencePipelineRetrieveUsersParams = Openlayer::Models::InferencePipelineRetrieveUsersParams
+
   InferencePipelines = Openlayer::Models::InferencePipelines
 
   InferencePipelineUpdateParams = Openlayer::Models::InferencePipelineUpdateParams

lib/openlayer/models/inference_pipeline_retrieve_users_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    # @see Openlayer::Resources::InferencePipelines#retrieve_users
+    class InferencePipelineRetrieveUsersParams < Openlayer::Internal::Type::BaseModel
+      extend Openlayer::Internal::Type::RequestParameters::Converter
+      include Openlayer::Internal::Type::RequestParameters
+
+      # @!attribute page
+      #   The page to return in a paginated query.
+      #
+      #   @return [Integer, nil]
+      optional :page, Integer
+
+      # @!attribute per_page
+      #   Maximum number of items to return per page.
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!method initialize(page: nil, per_page: nil, request_options: {})
+      #   @param page [Integer] The page to return in a paginated query.
+      #
+      #   @param per_page [Integer] Maximum number of items to return per page.
+      #
+      #   @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

lib/openlayer/models/inference_pipeline_retrieve_users_response.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    # @see Openlayer::Resources::InferencePipelines#retrieve_users
+    class InferencePipelineRetrieveUsersResponse < Openlayer::Internal::Type::BaseModel
+      # @!attribute items
+      #   Array of user aggregation data
+      #
+      #   @return [Array<Openlayer::Models::InferencePipelineRetrieveUsersResponse::Item>]
+      required :items,
+               -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::InferencePipelineRetrieveUsersResponse::Item] }
+
+      # @!method initialize(items:)
+      #   @param items [Array<Openlayer::Models::InferencePipelineRetrieveUsersResponse::Item>] Array of user aggregation data
+
+      class Item < Openlayer::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique user identifier
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute cost
+        #   Total cost for this user
+        #
+        #   @return [Float]
+        required :cost, Float
+
+        # @!attribute date_of_first_record
+        #   Timestamp of the user's first event/trace
+        #
+        #   @return [Time]
+        required :date_of_first_record, Time, api_name: :dateOfFirstRecord
+
+        # @!attribute date_of_last_record
+        #   Timestamp of the user's last event/trace
+        #
+        #   @return [Time]
+        required :date_of_last_record, Time, api_name: :dateOfLastRecord
+
+        # @!attribute records
+        #   Total number of traces/rows for this user
+        #
+        #   @return [Integer]
+        required :records, Integer
+
+        # @!attribute sessions
+        #   Count of unique sessions for this user
+        #
+        #   @return [Integer]
+        required :sessions, Integer
+
+        # @!attribute tokens
+        #   Total token count for this user
+        #
+        #   @return [Float]
+        required :tokens, Float
+
+        # @!method initialize(id:, cost:, date_of_first_record:, date_of_last_record:, records:, sessions:, tokens:)
+        #   @param id [String] The unique user identifier
+        #
+        #   @param cost [Float] Total cost for this user
+        #
+        #   @param date_of_first_record [Time] Timestamp of the user's first event/trace
+        #
+        #   @param date_of_last_record [Time] Timestamp of the user's last event/trace
+        #
+        #   @param records [Integer] Total number of traces/rows for this user
+        #
+        #   @param sessions [Integer] Count of unique sessions for this user
+        #
+        #   @param tokens [Float] Total token count for this user
+      end
+    end
+  end
+end

lib/openlayer/resources/inference_pipelines.rb

@@ -87,6 +87,36 @@ def delete(inference_pipeline_id, params = {})
         )
       end
 
+      # 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.
+      #
+      # @overload retrieve_users(inference_pipeline_id, page: nil, per_page: nil, request_options: {})
+      #
+      # @param inference_pipeline_id [String] The inference pipeline id (a UUID).
+      #
+      # @param page [Integer] The page to return in a paginated query.
+      #
+      # @param per_page [Integer] Maximum number of items to return per page.
+      #
+      # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Openlayer::Models::InferencePipelineRetrieveUsersResponse]
+      #
+      # @see Openlayer::Models::InferencePipelineRetrieveUsersParams
+      def retrieve_users(inference_pipeline_id, params = {})
+        parsed, options = Openlayer::InferencePipelineRetrieveUsersParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["inference-pipelines/%1$s/users", inference_pipeline_id],
+          query: parsed.transform_keys(per_page: "perPage"),
+          model: Openlayer::Models::InferencePipelineRetrieveUsersResponse,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [Openlayer::Client]

rbi/openlayer/models.rbi

@@ -11,6 +11,9 @@ module Openlayer
   InferencePipelineRetrieveParams =
     Openlayer::Models::InferencePipelineRetrieveParams
 
+  InferencePipelineRetrieveUsersParams =
+    Openlayer::Models::InferencePipelineRetrieveUsersParams
+
   InferencePipelines = Openlayer::Models::InferencePipelines
 
   InferencePipelineUpdateParams =

rbi/openlayer/models/inference_pipeline_retrieve_users_params.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    class InferencePipelineRetrieveUsersParams < Openlayer::Internal::Type::BaseModel
+      extend Openlayer::Internal::Type::RequestParameters::Converter
+      include Openlayer::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Openlayer::InferencePipelineRetrieveUsersParams,
+            Openlayer::Internal::AnyHash
+          )
+        end
+
+      # The page to return in a paginated query.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
+
+      sig { params(page: Integer).void }
+      attr_writer :page
+
+      # Maximum number of items to return per page.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :per_page
+
+      sig { params(per_page: Integer).void }
+      attr_writer :per_page
+
+      sig do
+        params(
+          page: Integer,
+          per_page: Integer,
+          request_options: Openlayer::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The page to return in a paginated query.
+        page: nil,
+        # Maximum number of items to return per page.
+        per_page: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            page: Integer,
+            per_page: Integer,
+            request_options: Openlayer::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

rbi/openlayer/models/inference_pipeline_retrieve_users_response.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    class InferencePipelineRetrieveUsersResponse < Openlayer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Openlayer::Models::InferencePipelineRetrieveUsersResponse,
+            Openlayer::Internal::AnyHash
+          )
+        end
+
+      # Array of user aggregation data
+      sig do
+        returns(
+          T::Array[
+            Openlayer::Models::InferencePipelineRetrieveUsersResponse::Item
+          ]
+        )
+      end
+      attr_accessor :items
+
+      sig do
+        params(
+          items:
+            T::Array[
+              Openlayer::Models::InferencePipelineRetrieveUsersResponse::Item::OrHash
+            ]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Array of user aggregation data
+        items:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            items:
+              T::Array[
+                Openlayer::Models::InferencePipelineRetrieveUsersResponse::Item
+              ]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Item < Openlayer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Models::InferencePipelineRetrieveUsersResponse::Item,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        # The unique user identifier
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Total cost for this user
+        sig { returns(Float) }
+        attr_accessor :cost
+
+        # Timestamp of the user's first event/trace
+        sig { returns(Time) }
+        attr_accessor :date_of_first_record
+
+        # Timestamp of the user's last event/trace
+        sig { returns(Time) }
+        attr_accessor :date_of_last_record
+
+        # Total number of traces/rows for this user
+        sig { returns(Integer) }
+        attr_accessor :records
+
+        # Count of unique sessions for this user
+        sig { returns(Integer) }
+        attr_accessor :sessions
+
+        # Total token count for this user
+        sig { returns(Float) }
+        attr_accessor :tokens
+
+        sig do
+          params(
+            id: String,
+            cost: Float,
+            date_of_first_record: Time,
+            date_of_last_record: Time,
+            records: Integer,
+            sessions: Integer,
+            tokens: Float
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique user identifier
+          id:,
+          # Total cost for this user
+          cost:,
+          # Timestamp of the user's first event/trace
+          date_of_first_record:,
+          # Timestamp of the user's last event/trace
+          date_of_last_record:,
+          # Total number of traces/rows for this user
+          records:,
+          # Count of unique sessions for this user
+          sessions:,
+          # Total token count for this user
+          tokens:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              cost: Float,
+              date_of_first_record: Time,
+              date_of_last_record: Time,
+              records: Integer,
+              sessions: Integer,
+              tokens: Float
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end