All Implemented Interfaces:: com.openai.core.Params


public final class FileBatchCreateParams
 implements Params

Create a vector store file batch.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`FileBatchCreateParams.Body`
`public final class`	`FileBatchCreateParams.Builder`	A builder for FileBatchCreateParams.
`public final class`	`FileBatchCreateParams.Attributes`	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.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`vectorStoreId()`
`final List<String>`	`fileIds()`	A list of File IDs that the vector store should use.
`final Optional<FileBatchCreateParams.Attributes>`	`attributes()`	Set of 16 key-value pairs that can be attached to an object.
`final Optional<FileChunkingStrategyParam>`	`chunkingStrategy()`	The chunking strategy used to chunk the file(s).
`final JsonField<List<String>>`	`_fileIds()`	Returns the raw JSON value of fileIds.
`final JsonField<FileBatchCreateParams.Attributes>`	`_attributes()`	Returns the raw JSON value of attributes.
`final JsonField<FileChunkingStrategyParam>`	`_chunkingStrategy()`	Returns the raw JSON value of chunkingStrategy.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`final FileBatchCreateParams.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static FileBatchCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of FileBatchCreateParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - vectorStoreId
```
 final String vectorStoreId()
```
  - fileIds
```
 final List<String> fileIds()
```
    A list of File IDs that the vector store should use. Useful for tools like file_search that can access files.
  - attributes
```
 final Optional<FileBatchCreateParams.Attributes> attributes()
```
    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.
  - chunkingStrategy
```
 final Optional<FileChunkingStrategyParam> chunkingStrategy()
```
    The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty.
  - _fileIds
```
 final JsonField<List<String>> _fileIds()
```
    Returns the raw JSON value of fileIds.
    Unlike fileIds, this method doesn't throw if the JSON field has an unexpected type.
  - _attributes
```
 final JsonField<FileBatchCreateParams.Attributes> _attributes()
```
    Returns the raw JSON value of attributes.
    Unlike attributes, this method doesn't throw if the JSON field has an unexpected type.
  - _chunkingStrategy
```
 final JsonField<FileChunkingStrategyParam> _chunkingStrategy()
```
    Returns the raw JSON value of chunkingStrategy.
    Unlike chunkingStrategy, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - toBuilder
```
 final FileBatchCreateParams.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static FileBatchCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of FileBatchCreateParams.
    The following fields are required:
    .vectorStoreId() .fileIds()

Class FileBatchCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

vectorStoreId

fileIds

attributes

chunkingStrategy

_fileIds

_attributes

_chunkingStrategy

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

_pathParam

_headers

_queryParams

toBuilder

equals

hashCode

toString

builder