The xproxy_result Object

The xproxy_result object contains essential information about a request's execution, including cost calculations and limit status. It is returned whenever a request completes successfully (HTTP 200) and under certain failure conditions, such as when a limit blocks a request (HTTP 400).

Availability by Integration Method

Where and how you can access the xproxy_result object depends on your integration method:

Direct Provider Call with Telemetry (Recommended Approach)

Using @track decorator or track_context() function

When using the @track decorator or track_context() function with direct provider calls the payi instrumentation automatically submits telemetry data to the Ingest API. Upon successful submission, the instrumentation will add an xproxy_result attribute to the providers repsonse object.

Example of how to access the attribute:

def call_inference_provider():
  with track_context():
    # Placehold for your inference call
    response = provider.create()

    # Telemetry submission can fail (transient network errors, service unavailable, etc) 
		# so it is not guaranteed that the `xproxy_result` attribute has been added
    if hasattr(response, 'xproxy_result'):
        xproxy_result = getattr(response, xproxy_result)
        print(f"payi request id: {xproxy_result.request_id}")

In addition to the added attribute on the response the last xproxy_result result can be accessed by calling get_context() immediately after the inference call.

Without @track decorator or track_context() function

When making a direct call to a GenAI provider without using the @track decorator or track_context() function:

• You will need to manually call the Ingest API to submit telemetry data
• The Ingest API call will return the xproxy_result object containing cost calculations and limit status
• For Python applications, see the Python SDK Ingest API documentation for details on response handling
• For other languages, see the REST Ingest API documentation for details on the response format

xproxy_result Fields