[Bug]: The `attributes` key is missing in vector store file object

[PheysX]

Description

I try to get my vector store file object attributes from $this->client->vectorStores()->files()->retrieve($vectorStoreId, $fileId); but it is missing in the response structure

https://platform.openai.com/docs/api-reference/vector-stores-files/file-object#vector-stores-files/file-object-attributes

Steps To Reproduce

Just call the vector store file object $this->client->vectorStores()->files()->retrieve($vectorStoreId, $fileId); The attributes key is in request response but it is missing in from method from the VectorStoreFileResponse

OpenAI PHP Client Version

v0.10.3

PHP Version

8.4

Notes

No response

[iBotPeaches]

Do you have a sample JSON? I'm looking at the docs and I don't see any key named key and when I compare the 3 samples we test against:

• https://github.com/openai-php/client/blob/main/tests/Fixtures/VectorStoreFileBatch.php
• https://github.com/openai-php/client/blob/main/tests/Fixtures/VectorStoreFile.php
• https://github.com/openai-php/client/blob/main/tests/Fixtures/VectorStore.php

They all match with the OpenAI docs so I can't tell if anything is missing. So I just must be missing something obvious here.

Comparing with the sample you linked.

{
  "id": "file-abc123",
  "object": "vector_store.file",
  "usage_bytes": 1234,
  "created_at": 1698107661,
  "vector_store_id": "vs_abc123",
  "status": "completed",
  "last_error": null,
  "chunking_strategy": {
    "type": "static",
    "static": {
      "max_chunk_size_tokens": 800,
      "chunk_overlap_tokens": 400
    }
  }
}

[PheysX]

Sorry, that was probably not clear enough. The key attributes is missing, see docs The example is not 100% on the docs page (see the keys on the left site instead of the json example.

If you add attributes in the create process

$this->client->vectorStores()->files()->create($vectorStoreId, [
    'file_id' => $fileId,
    'attributes' => [
        'test' => '123',
    ],
]);

you should get it in the api response from the vectorStoreFileObject in https://github.com/openai-php/client/blob/main/src/Responses/VectorStores/Files/VectorStoreFileResponse.php#L44

I added it locally like this and it works for me.

<?php

declare(strict_types=1);

namespace OpenAI\Responses\VectorStores\Files;

use OpenAI\Contracts\ResponseContract;
use OpenAI\Contracts\ResponseHasMetaInformationContract;
use OpenAI\Responses\Concerns\ArrayAccessible;
use OpenAI\Responses\Concerns\HasMetaInformation;
use OpenAI\Responses\Meta\MetaInformation;
use OpenAI\Testing\Responses\Concerns\Fakeable;

/**
 * @implements ResponseContract<array{id: string, object: string, usage_bytes: int, created_at: int, vector_store_id: string, status: string, attributes: array<string, string>, last_error: ?array{code: string, message: string}, chunking_strategy: array{type: 'static', static: array{max_chunk_size_tokens: int, chunk_overlap_tokens: int}}|array{type: 'other'}}>
 */
final class VectorStoreFileResponse implements ResponseContract, ResponseHasMetaInformationContract
{
    /**
     * @use ArrayAccessible<array{id: string, object: string, usage_bytes: int, created_at: int, vector_store_id: string, status: string, attributes: array<string, string>, last_error: ?array{code: string, message: string}, chunking_strategy: array{type: 'static', static: array{max_chunk_size_tokens: int, chunk_overlap_tokens: int}}|array{type: 'other'}}>
     */
    use ArrayAccessible;

    use Fakeable;
    use HasMetaInformation;

    /**
     * @param  array<string, string>  $attributes
     */
    private function __construct(
        public readonly string $id,
        public readonly string $object,
        public readonly int $usageBytes,
        public readonly int $createdAt,
        public readonly string $vectorStoreId,
        public readonly string $status,
        public readonly array $attributes,
        public readonly ?VectorStoreFileResponseLastError $lastError,
        public readonly VectorStoreFileResponseChunkingStrategyStatic|VectorStoreFileResponseChunkingStrategyOther $chunkingStrategy,
        private readonly MetaInformation $meta,
    ) {}
 
    /**
     * Acts as static factory, and returns a new Response instance.
     *
     * @param  array{id: string, object: string, usage_bytes: int, created_at: int, vector_store_id: string, status: string, attributes: array<string, string>, last_error: ?array{code: string, message: string}, chunking_strategy: array{type: 'static', static: array{max_chunk_size_tokens: int, chunk_overlap_tokens: int}}|array{type: 'other'}}  $attributes
     */
    public static function from(array $attributes, MetaInformation $meta): self
    {
        return new self(
            $attributes['id'],
            $attributes['object'],
            $attributes['usage_bytes'],
            $attributes['created_at'],
            $attributes['vector_store_id'],
            $attributes['status'],
            $attributes['attributes'] ?? [],
            isset($attributes['last_error']) ? VectorStoreFileResponseLastError::from($attributes['last_error']) : null,
            $attributes['chunking_strategy']['type'] === 'static' ? VectorStoreFileResponseChunkingStrategyStatic::from($attributes['chunking_strategy']) : VectorStoreFileResponseChunkingStrategyOther::from($attributes['chunking_strategy']),
            $meta,
        );
    }

    /**
     * {@inheritDoc}
     */
    public function toArray(): array
    {
        return [
            'id' => $this->id,
            'object' => $this->object,
            'usage_bytes' => $this->usageBytes,
            'created_at' => $this->createdAt,
            'vector_store_id' => $this->vectorStoreId,
            'status' => $this->status,
            'attributes' => $this->attributes,
            'last_error' => $this->lastError instanceof VectorStoreFileResponseLastError ? $this->lastError->toArray() : null,
            'chunking_strategy' => $this->chunkingStrategy->toArray(),
        ];
    }
}

[iBotPeaches]

Okay thank you. I see. The custom generic key/value pairs you can add under attributes is not handled. I replicate and see that now.

[PheysX]

Should I do a PR or do you add it by yourself?