Fix/docs #1561

ivanleomk · 2025-05-26T12:42:15Z

Important

This pull request updates documentation links, corrects paths, and makes minor code adjustments to improve documentation accuracy and code clarity.

Documentation Links:
- Update link in docs/blog/index.md for "Unified Provider Interface in Instructor".
- Correct links in docs/blog/posts/announcing-instructor-responses-support.md and docs/blog/posts/announcing-unified-provider-interface.md to point to the correct openai-responses.md and anthropic.md.
- Fix various relative links in docs/concepts/semantic_validation.md, docs/examples/classification.md, docs/examples/index.md, docs/examples/tracing_with_langfuse.md, docs/learning/patterns/field_validation.md, docs/learning/patterns/list_extraction.md, docs/learning/patterns/nested_structure.md, docs/learning/patterns/optional_fields.md, docs/learning/patterns/prompt_templates.md, docs/learning/streaming/lists.md, docs/learning/validation/custom_validators.md, docs/learning/validation/field_level_validation.md, and docs/learning/validation/retry_mechanisms.md.
Code Adjustments:
- Rename openai_client to client in instructor/dsl/validators.py.
- Remove unused parameters throw_error and context from from_response() in instructor/function_calls.py.
Configuration:
- Add Installation to mkdocs.yml under Learning section.
- Add OpenAI Responses to mkdocs.yml under Integrations section.
- Update redirect_maps in mkdocs.yml for knowledge_graph.md to building_knowledge_graphs.md.

^{This description was created by}^{for 4205ad7. You can customize this summary. It will automatically update as commits are pushed.}

…inks.

…idation pages.

cloudflare-workers-and-pages · 2025-05-26T12:42:23Z

Deploying with Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status	Name	Latest Commit	Preview URL	Updated (UTC)
✅ Deployment successful! View logs	instructor	`f74bf55`	Visit preview	May 26 2025, 01:40 PM

ellipsis-dev

Important

Looks good to me! 👍

Reviewed everything up to 3c39a05 in 1 minute and 40 seconds. Click for details.

Reviewed 114 lines of code in 5 files
Skipped 0 files when reviewing.
Skipped posting 14 draft comments. View those below.
Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. docs/blog/index.md:40

Draft comment:
Updated 'Pandas DataFrame Examples' link to point to './posts/tidy-data-from-messy-tables.md#defining-a-custom-type'. Confirm that the target page exists.
Reason this comment was not posted:
Confidence changes required: 10% <= threshold 85% None

2. docs/blog/index.md:41

Draft comment:
Updated 'Streaming Response Examples' link to '../concepts/partial.md'. Verify that this new reference covers the intended content.
Reason this comment was not posted:
Confidence changes required: 10% <= threshold 85% None

3. docs/concepts/semantic_validation.md:386

Draft comment:
Changed anchor for 'llm_validator API Reference' from '#llm_validator' to '#api-reference'. Ensure the referenced anchor in api.md is updated accordingly.
Reason this comment was not posted:
Confidence changes required: 10% <= threshold 85% None

4. docs/examples/classification.md:8

Draft comment:
Simplified complete examples links: both [single classification] and [multi-label classification] now point to './bulk_classification.md'. Verify this change directs users correctly and that distinctions (if any) are maintained on the target page.
Reason this comment was not posted:
Confidence changes required: 20% <= threshold 85% None

5. docs/learning/validation/retry_mechanisms.md:56

Draft comment:
Updated max_retries details link from absolute '/concepts/retrying.md' to relative '../../concepts/retrying.md'. Confirm that the new path resolves as expected.
Reason this comment was not posted:
Confidence changes required: 10% <= threshold 85% None

6. docs/learning/validation/retry_mechanisms.md:87

Draft comment:
Updated fallback strategies link from 'fallback_strategies.md' to '../../concepts/error_handling.md'. Ensure that the new document covers the expected fallback behavior.
Reason this comment was not posted:
Confidence changes required: 10% <= threshold 85% None

7. docs/learning/validation/retry_mechanisms.md:165

Draft comment:
Revised the Related Resources links to use updated relative paths (e.g., Custom Validators now points to '../../concepts/reask_validation.md'). Verify that all updated links resolve correctly.
Reason this comment was not posted:
Confidence changes required: 10% <= threshold 85% None

8. mkdocs.yml:146

Draft comment:
Added 'Installation' under the Learning navigation. Confirm that 'learning/getting_started/installation.md' exists and the path is correct.
Reason this comment was not posted:
Confidence changes required: 10% <= threshold 85% None

9. mkdocs.yml:167

Draft comment:
Added 'OpenAI Responses' in the Integrations section. Ensure 'integrations/openai-responses.md' exists.
Reason this comment was not posted:
Confidence changes required: 10% <= threshold 85% None

10. mkdocs.yml:226

Draft comment:
Added 'Tracing with Langfuse' in the Cookbook navigation. Verify that 'examples/tracing_with_langfuse.md' is available and correctly linked.
Reason this comment was not posted:
Confidence changes required: 10% <= threshold 85% None

11. mkdocs.yml:159

Draft comment:
Removed the 'Fallback Strategies' entry under Learning. Ensure that fallback strategy information is accessible through the updated documentation (likely via error_handling.md).
Reason this comment was not posted:
Confidence changes required: 10% <= threshold 85% None

12. docs/examples/classification.md:8

Draft comment:
There appear to be hyphenation issues in this line. The phrases "tasks-specifically," and "classifications-using" may be typographical errors. Consider revising them to "tasks, specifically," and "classifications using" (or using an em dash if that was intended) for improved clarity.
Reason this comment was not posted:
Comment was on unchanged code.

13. docs/learning/validation/retry_mechanisms.md:170

Draft comment:
Potential typographical error: The link for "Custom Validators" is now pointing to ../../concepts/reask_validation.md. Please confirm if reask_validation.md is correct or if it should remain custom_validators.md.
Reason this comment was not posted:
Comment looked like it was already resolved.

14. docs/learning/validation/retry_mechanisms.md:171

Draft comment:
The link for "Fallback Strategies" has been updated to ../../concepts/error_handling.md. Please verify that this is the intended file, as the previous reference was fallback_strategies.md.
Reason this comment was not posted:
Comment did not seem useful. Confidence is useful = 0% <= threshold 85% The comment is asking the author to verify if the change in the link is intentional. This falls under asking the author to confirm their intention, which is against the rules. Therefore, this comment should not be approved.

Workflow ID: wflow_va3MMX3boUbT6HNd

^{You can customize}^{by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}

ivanleomk · 2025-05-26T13:05:42Z

We get this beautiful screen now on mkdocs serve

ivanleo@Ivans-MacBook-Pro ~/D/c/instructor (fix/docs)> mkdocs serve
INFO    -  Building documentation...
INFO    -  Cleaning site directory
INFO    -  Documentation built in 8.49 seconds
INFO    -  [21:05:14] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO    -  [21:05:14] Serving on http://127.0.0.1:8000/

ellipsis-dev

Important

Looks good to me! 👍

Reviewed ea169d9 in 1 minute and 36 seconds. Click for details.

Reviewed 194 lines of code in 9 files
Skipped 0 files when reviewing.
Skipped posting 10 draft comments. View those below.
Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. docs/blog/index.md:9

Draft comment:
Updated the link for 'Unified Provider Interface in Instructor' to point to 'announcing-unified-provider-interface.md'. Please confirm that the new file exists and that the link is consistent throughout the docs.
Reason this comment was not posted:
Comment did not seem useful. Confidence is useful = 0% <= threshold 85% The comment is asking the PR author to confirm the existence of a file and consistency of links, which violates the rule against asking for confirmation or verification. It does not provide a specific code suggestion or point out a specific issue that needs addressing.

2. docs/blog/posts/announcing-instructor-responses-support.md:153

Draft comment:
Relative link for the OpenAI Responses API Guide is updated to use '../../integrations/openai-responses.md'. This looks correct; please ensure the path resolves as expected.
Reason this comment was not posted:
Comment did not seem useful. Confidence is useful = 0% <= threshold 85% This comment is asking to ensure that a path resolves correctly, which is similar to asking the author to double-check something. It doesn't provide a specific suggestion or point out a clear issue. It also doesn't relate to any of the additional rules provided.

3. docs/blog/posts/announcing-unified-provider-interface.md:196

Draft comment:
Updated relative paths for 'Unified Prompt Caching API' and 'Unified Multimodal Object Handling'. Verify that these new links resolve correctly to the intended resources.
Reason this comment was not posted:
Comment did not seem useful. Confidence is useful = 0% <= threshold 85% The comment is asking the PR author to verify that the new links resolve correctly, which is against the rules of asking the author to double-check things. It doesn't provide a specific suggestion or point out a specific issue with the code.

4. docs/examples/index.md:69

Draft comment:
The 'Knowledge Graph Building' link was updated to '../examples/building_knowledge_graphs.md'. Ensure that the file was renamed accordingly and all references have been updated.
Reason this comment was not posted:
Comment looked like it was already resolved.

5. docs/examples/tracing_with_langfuse.md:13

Draft comment:
The Langfuse signup URL now includes the 'https://' prefix, which improves link reliability. Consider ensuring consistent note styling throughout the docs.
Reason this comment was not posted:
Comment did not seem useful. Confidence is useful = 0% <= threshold 85% This comment is purely informative and does not provide a specific actionable suggestion or point out a specific issue in the code. It also does not relate to any of the additional rules provided.

6. docs/learning/patterns/field_validation.md:56

Draft comment:
Several relative links (e.g., to Fields, Custom Validators, Enums, Retry Mechanisms) have been updated. These look consistent, but please verify that all new paths correctly resolve within the documentation structure.
Reason this comment was not posted:
Comment did not seem useful. Confidence is useful = 0% <= threshold 85% This comment is asking the PR author to verify the correctness of relative links in the documentation. It doesn't provide a specific suggestion or point out a specific issue, which violates the rule against asking the author to double-check things. Therefore, this comment should be removed.

7. instructor/dsl/validators.py:68

Draft comment:
The docstring now refers to the parameter as 'client' instead of 'openai_client'. Ensure that the updated parameter name is propagated through the code and documentation consistently.
Reason this comment was not posted:
Comment looked like it was already resolved.

8. instructor/function_calls.py:184

Draft comment:
Removed the 'throw_error' and 'context' parameters from the function's docstring. Confirm that any dependent code or documentation has been updated to reflect their removal.
Reason this comment was not posted:
Comment did not seem useful. Confidence is useful = 0% <= threshold 85% The comment is asking the PR author to confirm that dependent code or documentation has been updated, which violates the rule against asking for confirmation or ensuring behavior is intended. It does not provide a specific suggestion or point out a specific issue with the code.

9. mkdocs.yml:162

Draft comment:
A new 'Tutorials' navigation entry was added and several integration links (e.g., Knowledge Graph Building) have been updated. Please verify that all updated file paths exist and that redirects are consistent.
Reason this comment was not posted:
Comment did not seem useful. Confidence is useful = 0% <= threshold 85% The comment is asking the PR author to verify file paths and redirects, which falls under asking the author to double-check things. This violates the rule against asking the author to confirm or ensure things. Therefore, this comment should be removed.

10. mkdocs.yml:229

Draft comment:
Typographical note: The file path has been changed from 'building_knowledge_graph.md' to 'building_knowledge_graphs.md'. Please verify that the addition of the 's' in 'graphs' is intentional and matches the actual file name.
Reason this comment was not posted:
Comment did not seem useful. Confidence is useful = 80% <= threshold 85% The comment is asking the author to verify the change in the file name, which is not allowed according to the rules. However, it is pointing out a specific change that could potentially be an error, which is useful. The comment does not violate any of the additional rules and is specific to a change in the file name, which could affect links or references to the file.

Workflow ID: wflow_ToaYXZgTB1VpnR4e

^{You can customize}^{by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}

…examples.

ellipsis-dev

Important

Looks good to me! 👍

Reviewed 4205ad7 in 1 minute and 17 seconds. Click for details.

Reviewed 78 lines of code in 1 files
Skipped 0 files when reviewing.
Skipped posting 3 draft comments. View those below.
Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. docs/learning/streaming/lists.md:29

Draft comment:
The basic list streaming example now uses 'response_model=Iterable[Book]' but has removed the 'stream=True' parameter, unlike the tasks example. Ensure both examples consistently include the streaming flag if streaming behavior is intended.
Reason this comment was not posted:
Confidence changes required: 80% <= threshold 85% None

2. docs/learning/streaming/lists.md:68

Draft comment:
Message formatting differs between examples. The tasks example uses a multi-line dict while the basic example uses a single-line dict. Consider standardizing the format for clarity.
Reason this comment was not posted:
Confidence changes required: 50% <= threshold 85% None

3. docs/learning/streaming/lists.md:29

Draft comment:
The inline comment noting the use of List was removed. Consider adding an updated explanation on why Iterable is now preferred for streaming lists to provide context to users.
Reason this comment was not posted:
Confidence changes required: 60% <= threshold 85% None

Workflow ID: wflow_dEf7KpTcCG9scjgb

^{You can customize}^{by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}

ivanleomk added 4 commits May 26, 2025 19:59

feat: Add documentation for OpenAI Responses integration.

e080ab9

docs: Update mkdocs.yml with new learning and example documentation l…

cfa1f2c

…inks.

docs: Update internal links and fix typos in documentation.

3c39a05

docs: Correct relative links in custom validators and field-level val…

ea659b1

…idation pages.

github-actions bot added documentation Improvements or additions to documentation size:M This PR changes 30-99 lines, ignoring generated files. labels May 26, 2025

ellipsis-dev bot reviewed May 26, 2025

View reviewed changes

ivanleomk added 2 commits May 26, 2025 20:51

chore: Update documentation links to reflect project restructuring.

559d2e5

fix: Update documentation and code for accuracy and consistency.

ea169d9

ellipsis-dev bot reviewed May 26, 2025

View reviewed changes

fix: Replace List with Iterable for streaming lists in documentation …

4205ad7

…examples.

ellipsis-dev bot reviewed May 26, 2025

View reviewed changes

Merge branch 'main' into fix/docs

f74bf55

ivanleomk merged commit 80b5961 into main May 26, 2025
12 of 15 checks passed

ivanleomk deleted the fix/docs branch May 26, 2025 13:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Fix/docs #1561

Fix/docs #1561

Uh oh!

ivanleomk commented May 26, 2025 •

edited by ellipsis-dev bot

Loading

Uh oh!

cloudflare-workers-and-pages bot commented May 26, 2025 •

edited

Loading

Uh oh!

ellipsis-dev bot left a comment

Uh oh!

ivanleomk commented May 26, 2025

Uh oh!

ellipsis-dev bot left a comment

Uh oh!

ellipsis-dev bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Fix/docs #1561

Fix/docs #1561

Uh oh!

Conversation

ivanleomk commented May 26, 2025 • edited by ellipsis-dev bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cloudflare-workers-and-pages bot commented May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying with Cloudflare Workers

Uh oh!

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

Uh oh!

ivanleomk commented May 26, 2025

Uh oh!

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

Uh oh!

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

ivanleomk commented May 26, 2025 •

edited by ellipsis-dev bot

Loading

cloudflare-workers-and-pages bot commented May 26, 2025 •

edited

Loading