Issue #11004: enable additional docstring snippets in CI validation

[TanKaizokuO]

Related Issues

• part of Allow more docstrings code snippets to run in the CI #11004

Proposed Changes

Enabled 8 additional docstring code snippets to run in CI by removing <!-- test-ignore --> markers and making examples CI-friendly.

Key updates:

• Replaced nonexistent file references with valid test assets or ByteStream.
• Mocked OpenAI client initialization and API responses in OpenAI embedder examples.
• Mocked Sentence Transformers backend to avoid model downloads.
• Mocked Hugging Face backend for NamedEntityExtractor.
• Mocked OpenAPIClient.from_spec to avoid external requests.

How did you test it?

Regenerated docs and validated snippets:

hatch run docs

hatch -e test run python docs-website/scripts/test_python_snippets.py --verbose \
tmp_api_reference/converters_api.md \
tmp_api_reference/embedders_api.md \
tmp_api_reference/extractors_api.md \
tmp_api_reference/connectors_api.md

Additional passing snippets:

• converters: +2
• embedders: +4
• extractors: +1
• connectors: +1

Total: +8 passing snippets

Also verified:

hatch run fmt
hatch run test:types

Notes for the reviewer

• Changes are limited to documentation examples.
• Mocking is used to make examples deterministic and CI-compatible.
• All removed <!-- test-ignore --> markers were validated successfully.

Checklist

• I have read the contributors guidelines and code of conduct.
• I have updated the related issue with new insights and changes.
• I have added unit tests and updated the docstrings.
• I've used a conventional commit type for my PR title.
• I have documented my code.
• I have added a release note file.
• I have run pre-commit hooks and fixed any issues.

[vercel]

@TanKaizokuO is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

[CLAassistant]

All committers have signed the CLA.

[anakin87]

Please sign the CLA, then I'll review the PR

[anakin87]

See #11468 (review)