Azure / Azure/azure-openai-benchmark

Documenting reference for header values used.

Open
#32 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
154
Forks
76
PR merge metrics
No merged PRs in 30d

Description

It would be good to document the source/reference of all external header values which we are relying upon.

image

FileName: oairequester.py

For example,
It's difficult to find the reference of "azure-openai-deployment-utilization" on a quick web/Azure documentation search.

As an example, following documentation link can be ref. of headers like "retry-after-ms"
![image](https://github.com/Azure/azure-openai-benchmark/assets/12629751/a518837c-15ce-4a81-a5f0-63721eebf922)
https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/provisioned-throughput

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with oairequester.py and inventory the external header values used there, including "azure-openai-deployment-utilization" and "retry-after-ms". Find the authoritative Azure OpenAI references for each value and document those sources; the work is done when every external header value in the file has a reference.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.