Fix: Correct parameter passing in vector_stores poll() methods

[yashwantbezawada]

Summary

Fixes #2724 - vector_stores.file_batches.poll() now correctly returns VectorStoreFileBatch instead of VectorStore

Problem

When users called client.vector_stores.file_batches.poll(), the method returned a VectorStore object with the vector store's ID instead of returning the VectorStoreFileBatch object with the batch ID.

User's Reproduction

batch_obj = client.vector_stores.file_batches.create(
    vector_store_id=vector_store_obj.id,
    file_ids=[file_obj.id]
)
# batch_obj.id = "vsfb_ibj_6905db4e..."  ✅ Correct

response = client.vector_stores.file_batches.poll(
    batch_id=batch_obj.id,
    vector_store_id=vector_store_obj.id
)
# response.id = "vs_6905db4d..."  ❌ WRONG! (vector store ID, not batch ID)
# response.object = "vector_store"  ❌ WRONG! (should be "vector_store.file_batch")

Root Cause

The poll() method internally calls self.with_raw_response.retrieve() to fetch the batch status. When passing the first parameter (batch_id or file_id) as a positional argument, the method wrapper didn't properly preserve the parameter mapping, causing parameters to be swapped.

Code at fault (file_batches.py:305):

response = self.with_raw_response.retrieve(
    batch_id,  # ❌ Positional - causes parameter swap
    vector_store_id=vector_store_id,
    extra_headers=headers,
)

This resulted in the API being called with the wrong URL:

• Expected: GET /vector_stores/{vs_id}/file_batches/{batch_id}
• Actual: GET /vector_stores/{batch_id} or similar malformed URL
• Result: API returns VectorStore object instead of VectorStoreFileBatch

Solution

Changed all poll() methods to pass the first parameter as a keyword argument instead of positional:

response = self.with_raw_response.retrieve(
    batch_id=batch_id,  # ✅ Keyword - explicit parameter mapping
    vector_store_id=vector_store_id,
    extra_headers=headers,
)

This ensures explicit parameter mapping and prevents confusion in the method wrapper, while maintaining backward compatibility (Python allows positional parameters to be passed as keywords).

Changes

Fixed 4 instances of this bug across 2 files:

src/openai/resources/vector_stores/file_batches.py:

• Line 306: retrieve(batch_id, ...) → retrieve(batch_id=batch_id, ...) (sync)
• Line 651: retrieve(batch_id, ...) → retrieve(batch_id=batch_id, ...) (async)

src/openai/resources/vector_stores/files.py:

• Line 340: retrieve(file_id, ...) → retrieve(file_id=file_id, ...) (sync)
• Line 748: retrieve(file_id, ...) → retrieve(file_id=file_id, ...) (async)

Testing

Before Fix

{
  "id": "vs_6905db4d...",  // ❌ Vector Store ID
  "object": "vector_store",  // ❌ Wrong type
  "name": "test_vector_store",  // ❌ VS field
  "file_counts": {...}  // Mixed fields
}

After Fix

{
  "id": "vsfb_ibj_6905db4e...",  // ✅ Batch ID  
  "object": "vector_store.file_batch",  // ✅ Correct type
  "status": "completed",  // ✅ Batch fields
  "file_counts": {...}  // ✅ Batch fields
}

Impact

• Bug fixed: Both file_batches.poll() and files.poll() now return correct object types
• No breaking changes: Maintains full backward compatibility
• Affects: All users calling vector_stores.file_batches.poll() or vector_stores.files.poll()

Related

• Also fixed the same issue in files.poll() which likely had the same bug but wasn't reported yet

Checklist

• Root cause identified through deep investigation
• Fix tested against user's reproduction scenario
• No breaking changes to existing functionality
• Maintains backward compatibility
• Fixed both sync and async versions
• Fixed similar issues in related files

[yashwantbezawada]

Closing this PR - it accidentally included changes from #2733. I've opened #2735 with only the vector_stores poll() fixes (clean PR with just the 4 lines changed).