Skip to content

docs(openai): add a PZERO OpenAI-compatible example - #8427

Open
电大老baby (HhH666-ux) wants to merge 1 commit into
microsoft:mainfrom
HhH666-ux:docs/8101-pzero-example
Open

电大老baby (HhH666-ux) wants to merge 1 commit into
microsoft:mainfrom
HhH666-ux:docs/8101-pzero-example

Conversation

@HhH666-ux

Copy link
Copy Markdown

Problem

The OpenAIChatCompletionClient reference shows Ollama as the non-OpenAI example and nothing for other prepaid or hosted OpenAI-compatible endpoints. Readers have to infer the host, key format, and the fact that model_info is required because the model id is not an OpenAI name.

Implementation

Add a short PZERO example directly after the Ollama snippet in the client docstring, using the existing base_url + model_info seam. No provider-specific API or dependency is added.

Verification

  • python -m py_compile python/packages/autogen-ext/src/autogen_ext/models/openai/_openai_client.py (docstring change compiles).
  • The snippet mirrors the documented OpenAIChatCompletionClient arguments and uses ModelFamily.UNKNOWN for a non-OpenAI family.

Limitations

Documentation only; the example is not exercised by a live endpoint in CI.

Fixes #8101

@HhH666-ux

Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

1 similar comment
@HhH666-ux

Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: PZERO OpenAIChatCompletionClient example

1 participant