Add header to Codex API requests for capturing product analytics data #53
Conversation
kelsey-wong
changed the title
|
The Python package version we're currently including in headers is from the |
|
The PRD mentions supporting the ability to opt out of telemetry. Seems like that's not addressed here, so wondering if you had a plan for that? |
I'm not including the Including the |
The telemetry won't be sent directly from this client library code - it'll be sent from the Codex backend (I'm still in the middle of making that change). So we should be alright on that requirement! |
|
@axl1313 branch is updated and re-tested according to your feedback! |
| @@ -90,6 +90,13 @@ Automated releases are handled by the [release workflow][release-workflow] which | |||
| [hatch-version]: https://hatch.pypa.io/latest/version/#updating | |||
| [changelog]: CHANGELOG.md | |||
|
|
|||
|
|
|||
| ### How to build and install the package locally | |||
There was a problem hiding this comment.
I think you can also just do pip install -e <local path to repo>
| self, *, integration_type: str, package_version: str = package_version, source: str = "cleanlab-codex-python" | ||
| ): | ||
| class IntegrationType(str, Enum): | ||
| """Types of integrations that can use the SDK.""" |
There was a problem hiding this comment.
nit:
| """Types of integrations that can use the SDK.""" | |
| """Supported methods for integrating Codex into a RAG system using this library""" |
Key Info
What changed?
AnalyticsMetadatawhich is passed in request headers to Codex API, for the purpose of capturing product analytics about usage; mainly, what integration type (tool or backup) the request is associated withutils/project.pyand moved intoproject.pytest_codex_toolWhat do you want the reviewer(s) to focus on?
'user-agent': 'Codex/Python 0.1.0-alpha.9'), which I do plan on passing to Posthog as wellChecklist
CODEX_BASE_URL); verified that the headers are passed properly