Enhancement: Expose Response Headers and Rate Limit Metrics, Efficiency Logging

[mecfletcher]

Overview

This pull request introduces several enhancements to the open-ai project. Key changes include exposing response headers, rate limit metrics, and improvements in efficiency logging.

Key Changes

• Response Headers Exposure: The response headers are now accessible, allowing clients to get more detailed information about their API requests.
• Rate Limit Metrics: Rate limit information is now available, enabling users to track and manage their API usage more effectively.
• Efficiency Logging: Added logging for processing time (processingMs), providing insights into the performance and efficiency of API requests.

Files Changed

• src/OpenAi.php: Major changes include:
  • Addition of private arrays $responseHeaders and $rateLimitInfo.
  • Implementation of methods for setting and getting response headers and rate limit info.
  • Addition of hydrateRateLimitInfo and hydrateProcessingMs methods for processing the corresponding metrics.

Impact

These enhancements will provide users with more control and transparency when interacting with the API. The exposure of rate limits and processing times will aid in efficient API usage and troubleshooting.

Usage

• getRateLimitInfo(): returns an array of key-value pairs containing all of the ratelimit info provided via the OpenAI Api response headers:

  $rateLimitInfo = $OpenAi->getRateLimitInfo();

  $rateLimitInfo =[
  'ratelimit-limit-requests' => $responseHeaders['x-ratelimit-limit-requests'],
  'ratelimit-limit-tokens' => $responseHeaders['x-ratelimit-limit-tokens'],
  'ratelimit-remaining-requests' => $responseHeaders['x-ratelimit-remaining-requests'],
  'ratelimit-remaining-tokens' => $responseHeaders['x-ratelimit-remaining-tokens'],
  'ratelimit-reset-requests' => $responseHeaders['x-ratelimit-reset-requests'],
  'ratelimit-reset-tokens' => $responseHeaders['x-ratelimit-reset-tokens'],
  ];

• getProcessingMs(): returns an int equal to the server request/response processing time provided via the OpenAI Api response headers:

  $processingMs = $OpenAi->getProcessingMs()

  $processingMs = $responseHeaders['openai-processing-ms'];

From the OpenAi Docs:

[maximehinnekens]

This is highly needed!

[orhanerday]

Sorry for the delay, @mecfletcher.

Could you please explain to me how I can test this? Do you have any usage examples?

[mecfletcher]

@orhanerday I apologize for the delay on my end, I've added a usage section to the PR description and added some better formatting! Let me know if you have any other questions.