## List vector store files in a batch

`client.VectorStores.FileBatches.ListFiles(ctx, vectorStoreID, batchID, query) (*CursorPage[VectorStoreFile], error)`

**get** `/vector_stores/{vector_store_id}/file_batches/{batch_id}/files`

Returns a list of vector store files in a batch.

### Parameters

- `vectorStoreID string`

- `batchID string`

- `query VectorStoreFileBatchListFilesParams`

  - `After param.Field[string]`

    A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

  - `Before param.Field[string]`

    A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

  - `Filter param.Field[VectorStoreFileBatchListFilesParamsFilter]`

    Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.

    - `const VectorStoreFileBatchListFilesParamsFilterInProgress VectorStoreFileBatchListFilesParamsFilter = "in_progress"`

    - `const VectorStoreFileBatchListFilesParamsFilterCompleted VectorStoreFileBatchListFilesParamsFilter = "completed"`

    - `const VectorStoreFileBatchListFilesParamsFilterFailed VectorStoreFileBatchListFilesParamsFilter = "failed"`

    - `const VectorStoreFileBatchListFilesParamsFilterCancelled VectorStoreFileBatchListFilesParamsFilter = "cancelled"`

  - `Limit param.Field[int64]`

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

  - `Order param.Field[VectorStoreFileBatchListFilesParamsOrder]`

    Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

    - `const VectorStoreFileBatchListFilesParamsOrderAsc VectorStoreFileBatchListFilesParamsOrder = "asc"`

    - `const VectorStoreFileBatchListFilesParamsOrderDesc VectorStoreFileBatchListFilesParamsOrder = "desc"`

### Returns

- `type VectorStoreFile struct{…}`

  A list of files attached to a vector store.

  - `ID string`

    The identifier, which can be referenced in API endpoints.

  - `CreatedAt int64`

    The Unix timestamp (in seconds) for when the vector store file was created.

  - `LastError VectorStoreFileLastError`

    The last error associated with this vector store file. Will be `null` if there are no errors.

    - `Code string`

      One of `server_error`, `unsupported_file`, or `invalid_file`.

      - `const VectorStoreFileLastErrorCodeServerError VectorStoreFileLastErrorCode = "server_error"`

      - `const VectorStoreFileLastErrorCodeUnsupportedFile VectorStoreFileLastErrorCode = "unsupported_file"`

      - `const VectorStoreFileLastErrorCodeInvalidFile VectorStoreFileLastErrorCode = "invalid_file"`

    - `Message string`

      A human-readable description of the error.

  - `Object VectorStoreFile`

    The object type, which is always `vector_store.file`.

    - `const VectorStoreFileVectorStoreFile VectorStoreFile = "vector_store.file"`

  - `Status VectorStoreFileStatus`

    The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use.

    - `const VectorStoreFileStatusInProgress VectorStoreFileStatus = "in_progress"`

    - `const VectorStoreFileStatusCompleted VectorStoreFileStatus = "completed"`

    - `const VectorStoreFileStatusCancelled VectorStoreFileStatus = "cancelled"`

    - `const VectorStoreFileStatusFailed VectorStoreFileStatus = "failed"`

  - `UsageBytes int64`

    The total vector store usage in bytes. Note that this may be different from the original file size.

  - `VectorStoreID string`

    The ID of the [vector store](/api/reference/resources/vector_stores) that the [File](/api/reference/resources/files) is attached to.

  - `Attributes map[string, VectorStoreFileAttributeUnion]`

    Set of 16 key-value pairs that can be attached to an object. This can be
    useful for storing additional information about the object in a structured
    format, and querying for objects via API or the dashboard. Keys are strings
    with a maximum length of 64 characters. Values are strings with a maximum
    length of 512 characters, booleans, or numbers.

    - `string`

    - `float64`

    - `bool`

  - `ChunkingStrategy FileChunkingStrategyUnion`

    The strategy used to chunk the file.

    - `type StaticFileChunkingStrategyObject struct{…}`

      - `Static StaticFileChunkingStrategy`

        - `ChunkOverlapTokens int64`

          The number of tokens that overlap between chunks. The default value is `400`.

          Note that the overlap must not exceed half of `max_chunk_size_tokens`.

        - `MaxChunkSizeTokens int64`

          The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`.

      - `Type Static`

        Always `static`.

        - `const StaticStatic Static = "static"`

    - `type OtherFileChunkingStrategyObject struct{…}`

      This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the `chunking_strategy` concept was introduced in the API.

      - `Type Other`

        Always `other`.

        - `const OtherOther Other = "other"`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.VectorStores.FileBatches.ListFiles(
    context.TODO(),
    "vector_store_id",
    "batch_id",
    openai.VectorStoreFileBatchListFilesParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
```

#### Response

```json
{
  "data": [
    {
      "id": "id",
      "created_at": 0,
      "last_error": {
        "code": "server_error",
        "message": "message"
      },
      "object": "vector_store.file",
      "status": "in_progress",
      "usage_bytes": 0,
      "vector_store_id": "vector_store_id",
      "attributes": {
        "foo": "string"
      },
      "chunking_strategy": {
        "static": {
          "chunk_overlap_tokens": 0,
          "max_chunk_size_tokens": 100
        },
        "type": "static"
      }
    }
  ],
  "first_id": "file-abc123",
  "has_more": false,
  "last_id": "file-abc456",
  "object": "list"
}
```