Skip to content

Commit f05a4de

Browse files
jsonbaileyclaude
andcommitted
docs: remove API reference section from OpenAI provider README
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 1fa3d6a commit f05a4de

1 file changed

Lines changed: 0 additions & 47 deletions

File tree

  • packages/ai-providers/server-ai-openai

packages/ai-providers/server-ai-openai/README.md

Lines changed: 0 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -144,53 +144,6 @@ print(f"Success: {metrics.success}")
144144
print(f"Tokens used: {metrics.usage.total if metrics.usage else 'N/A'}")
145145
```
146146

147-
## API Reference
148-
149-
### OpenAIRunnerFactory
150-
151-
`OpenAIRunnerFactory` is an `AIProvider` that creates runners from LaunchDarkly AI configs.
152-
153-
#### Constructor
154-
155-
```python
156-
OpenAIRunnerFactory(client: Optional[AsyncOpenAI] = None)
157-
```
158-
159-
If `client` is omitted, an `AsyncOpenAI` client is created using `OPENAI_API_KEY` from the environment.
160-
161-
#### Methods
162-
163-
- `create_model(config) -> OpenAIModelRunner` — Create a runner for chat completions from an AI config.
164-
- `create_agent(config, tools=None) -> OpenAIAgentRunner` — Create a runner for an OpenAI agent (experimental).
165-
- `get_client() -> AsyncOpenAI` — Return the underlying `AsyncOpenAI` client.
166-
167-
### OpenAIModelRunner
168-
169-
`OpenAIModelRunner` implements the `Runner` protocol for OpenAI chat completions.
170-
171-
#### Constructor
172-
173-
```python
174-
OpenAIModelRunner(client: AsyncOpenAI, model_name: str, parameters: Dict[str, Any])
175-
```
176-
177-
#### Methods
178-
179-
- `run(input, output_type=None) -> RunnerResult` — Run the model with a string prompt or list of `LDMessage` objects. Pass `output_type` (JSON schema dict) for structured output.
180-
181-
### OpenAIAgentRunner
182-
183-
> [!CAUTION]
184-
> This feature is experimental and should NOT be considered ready for production use.
185-
> It may change or be removed without notice.
186-
187-
`OpenAIAgentRunner` implements the `Runner` protocol using the OpenAI Agents SDK
188-
(`openai-agents`). Requires `pip install openai-agents`.
189-
190-
#### Methods
191-
192-
- `run(input, output_type=None) -> RunnerResult` — Run the agent with the given input. The tool-calling loop is handled internally. Returns `RunnerResult` with `content`, `metrics` (including `tool_calls`), and `raw`.
193-
194147
## Documentation
195148

196149
For full documentation, please refer to the [LaunchDarkly AI SDK documentation](https://docs.launchdarkly.com/sdk/ai/python).

0 commit comments

Comments
 (0)