Skip to content

feat(api): add vault metadata and clarify web search locations - #3950

Closed
marcuswood-oai wants to merge 1 commit into
mainfrom
castiron/promotions/pr-145
Closed

marcuswood-oai wants to merge 1 commit into
mainfrom
castiron/promotions/pr-145

Conversation

@marcuswood-oai

Copy link
Copy Markdown
Contributor

Summary

Adds vault credential metadata to credential results and create/update requests, including metadata-only updates. Clarifies web search location defaults.

Changes

  • Add string-keyed metadata to vault credential results and create/update parameters.
  • Allow credential updates with metadata without requiring replacement authentication values.
  • Explain that omitted or null web search user locations default to the United States.
  • Describe how an approximate location without location fields avoids the fallback, and how location fields localize results.

Castiron-Internal-PR: openai/openai-python-internal#145
Castiron-Source-SHA: 80e06b0d9b66811d33d846516b7b144132d887dc
Castiron-Public-Base-SHA: 4d12746
@github-actions

Copy link
Copy Markdown
Contributor

Castiron custom code

✅ No new custom-code files detected.

47 mixed files remain; 0 existing customizations changed.

Compared 4d1274681db7 → 1f09e2a5b85a. Generated baselines verified.

47 existing customizations unchanged
  • api.md
  • scripts/castiron/README.md
  • scripts/castiron/custom_code_report.py
  • scripts/castiron/test_custom_code_report.py
  • src/openai/init.py
  • src/openai/_client.py
  • src/openai/resources/audio/transcriptions.py
  • src/openai/resources/audio/translations.py
  • src/openai/resources/beta/agents/sessions/sessions.py
  • src/openai/resources/beta/beta.py
  • src/openai/resources/beta/responses/responses.py
  • src/openai/resources/beta/threads/runs/runs.py
  • src/openai/resources/beta/threads/threads.py
  • src/openai/resources/chat/completions/completions.py
  • src/openai/resources/embeddings.py
  • src/openai/resources/files.py
  • src/openai/resources/live/forks.py
  • src/openai/resources/live/live.py
  • src/openai/resources/live/sideband.py
  • src/openai/resources/realtime/api.md
  • src/openai/resources/realtime/realtime.py
  • src/openai/resources/responses/responses.py
  • src/openai/resources/uploads/uploads.py
  • src/openai/resources/vector_stores/file_batches.py
  • src/openai/resources/vector_stores/files.py
  • src/openai/resources/videos.py
  • src/openai/resources/webhooks/init.py
  • src/openai/resources/webhooks/webhooks.py
  • src/openai/types/beta/agent_session_message.py
  • src/openai/types/chat/init.py
  • src/openai/types/chat/chat_completion_message_tool_call.py
  • src/openai/types/fine_tuning/fine_tuning_job_integration.py
  • src/openai/types/realtime/conversation_item_input_audio_transcription_delta_event.py
  • src/openai/types/realtime/realtime_error_event.py
  • src/openai/types/responses/init.py
  • src/openai/types/responses/response.py
  • src/openai/types/responses/response_function_web_search.py
  • src/openai/types/responses/response_function_web_search_param.py
  • src/openai/types/responses/responses_client_event.py
  • src/openai/types/responses/responses_client_event_param.py

7 more in the full report.

A changed generated baseline means this report cannot reliably identify which handwritten lines changed.

Inspect the custom-code diff

Download the exact patch produced by this run (requires repository access):

gh run download 35922899291 --repo openai/openai-python \
  --name castiron-custom-code-35922899291-1 --dir /tmp/castiron-custom-code-35922899291-1
git apply --stat /tmp/castiron-custom-code-35922899291-1/custom-code.patch
cat /tmp/castiron-custom-code-35922899291-1/custom-code.patch

Or reproduce it from an SDK checkout containing the vendored reporter:

git fetch --no-tags origin 4d1274681db7f34f671ff9e71adc1461d22a927b 1f09e2a5b85a8858d13afc6438107b99c1c6fdea
python3 scripts/castiron/custom_code_report.py report \
  --base 4d1274681db7f34f671ff9e71adc1461d22a927b \
  --head 1f09e2a5b85a8858d13afc6438107b99c1c6fdea --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-1f09e2a5b85a
cat /tmp/castiron-custom-code-1f09e2a5b85a/custom-code.patch

This is the current full custom patch for mixed files, not an attribution of only the handwritten lines changed by this PR.

Full report and patch

@jbeckwith-oai jbeckwith-oai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed at 1f09e2a. No actionable findings.

Reviewed the sync/async create and update body transforms, optional auth on updates, required response metadata, updated environment-credential fixture, and documentation-only web-search changes. The required response-metadata/model-construction change is the explicitly documented public-beta contract change, not an accidental omission.

Validation: 40 independent assertions against this head's actual transformed schema passed, including metadata key/value/count bounds and metadata-only, empty-map clearing, auth-only, and combined updates. Verified the complete semantic schema delta and generation hash. Exact-head hosted build/lint/test checks are green (conditional jobs are skipped). I did not rerun the full SDK suite locally.

@marcuswood-oai

Copy link
Copy Markdown
Contributor Author

Closing this broader update. A separate update will contain only the web-search approximate-location documentation changes.

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.

2 participants