[azure-ai-inference] Fix documentation typos and grammar in README and samples#48123
Open
kkchandi wants to merge 10 commits into
Open
[azure-ai-inference] Fix documentation typos and grammar in README and samples#48123kkchandi wants to merge 10 commits into
kkchandi wants to merge 10 commits into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 77e272d0-4d0f-42cf-b18b-50a5ab5b60e5
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 77e272d0-4d0f-42cf-b18b-50a5ab5b60e5
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 77e272d0-4d0f-42cf-b18b-50a5ab5b60e5
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 77e272d0-4d0f-42cf-b18b-50a5ab5b60e5
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 77e272d0-4d0f-42cf-b18b-50a5ab5b60e5
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 77e272d0-4d0f-42cf-b18b-50a5ab5b60e5
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 77e272d0-4d0f-42cf-b18b-50a5ab5b60e5
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 77e272d0-4d0f-42cf-b18b-50a5ab5b60e5
github-actions
Bot
added
the
AI Model Inference
|
Azure Pipelines: Successfully started running 1 pipeline(s). 9 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Contributor
There was a problem hiding this comment.
Pull request overview
Corrects typos and grammar in azure-ai-inference documentation and samples without changing behavior.
Changes:
- Fixes endpoint placeholder typos.
- Improves sample instructions, descriptions, and prompts.
- Corrects README grammar and terminology.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
README.md |
Corrects documentation typos and grammar. |
samples/README.md |
Improves sample guidance and descriptions. |
samples/sample_embeddings_azure_openai.py |
Corrects endpoint placeholder. |
samples/sample_chat_completions_with_tools.py |
Corrects tool documentation and prompts. |
samples/sample_chat_completions_with_structured_output.py |
Corrects instructions and schema description. |
samples/sample_chat_completions_with_entra_id_auth.py |
Corrects endpoint placeholder. |
samples/sample_chat_completions_streaming_with_tools.py |
Corrects documentation and prompts. |
samples/sample_chat_completions_azure_openai.py |
Corrects endpoint placeholder. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation-only fixes in the
azure-ai-inferencepackage (README, samples README, and sample docstrings/comments). No code or behavior changes.in of the form->in the form;resouce->resource(2 endpoint placeholders);retrive->retrieve;futher->further;wil->will;descirbed->described.use the a synchronous clients->use the synchronous clients;insall->install;your-unique-resouce-name->your-unique-resource-name(2);Test embeddings->Text embeddings;how do use->how to use(4 table rows).fight number->flight number;retrieves->retrieve;You an assistant->You are an assistant;next flights->next flight;resouce->resource.resouce->resource.may needs->may need;Descripes a recipe in details->Describes a recipe in detail.