// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. package openai import ( "context" "errors" "fmt" "net/http" "net/url" "slices" "sync" "github.com/openai/openai-go/v3/internal/apijson" "github.com/openai/openai-go/v3/internal/apiquery" "github.com/openai/openai-go/v3/internal/requestconfig" "github.com/openai/openai-go/v3/option" "github.com/openai/openai-go/v3/packages/pagination" "github.com/openai/openai-go/v3/packages/param" "github.com/openai/openai-go/v3/packages/respjson" "github.com/openai/openai-go/v3/shared/constant" ) // VectorStoreFileBatchService contains methods and other services that help with // interacting with the openai API. // // Note, unlike clients, this service does not read variables from the environment // automatically. You should not instantiate this service directly, and instead use // the [NewVectorStoreFileBatchService] method instead. type VectorStoreFileBatchService struct { Options []option.RequestOption } // NewVectorStoreFileBatchService generates a new service that applies the given // options to each request. These options are applied after the parent client's // options (if there is one), and before any request-specific options. func NewVectorStoreFileBatchService(opts ...option.RequestOption) (r VectorStoreFileBatchService) { r = VectorStoreFileBatchService{} r.Options = opts return } // Create a vector store file batch. func (r *VectorStoreFileBatchService) New(ctx context.Context, vectorStoreID string, body VectorStoreFileBatchNewParams, opts ...option.RequestOption) (res *VectorStoreFileBatch, err error) { opts = slices.Concat(r.Options, opts) opts = append([]option.RequestOption{option.WithHeader("OpenAI-Beta", "assistants=v2")}, opts...) if vectorStoreID == "" { err = errors.New("missing required vector_store_id parameter") return nil, err } path := fmt.Sprintf("vector_stores/%s/file_batches", vectorStoreID) err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...) return res, err } // Create a vector store file batch and polls the API until the task is complete. // Pass 0 for pollIntervalMs to enable default polling interval. func (r *VectorStoreFileBatchService) NewAndPoll(ctx context.Context, vectorStoreId string, body VectorStoreFileBatchNewParams, pollIntervalMs int, opts ...option.RequestOption) (res *VectorStoreFileBatch, err error) { batch, err := r.New(ctx, vectorStoreId, body, opts...) if err != nil { return nil, err } return r.PollStatus(ctx, vectorStoreId, batch.ID, pollIntervalMs, opts...) } // Uploads the given files concurrently and then creates a vector store file batch. // // If you've already uploaded certain files that you want to include in this batch // then you can pass their IDs through the file_ids argument. // // Pass 0 for pollIntervalMs to enable default polling interval. // // By default, if any file upload fails then an exception will be eagerly raised. func (r *VectorStoreFileBatchService) UploadAndPoll(ctx context.Context, vectorStoreID string, files []FileNewParams, fileIDs []string, pollIntervalMs int, opts ...option.RequestOption) (*VectorStoreFileBatch, error) { if len(files) <= 0 { return nil, errors.New("No `files` provided to process. If you've already uploaded files you should use `.NewAndPoll()` instead") } filesService := NewFileService(r.Options...) uploadedFileIDs := make(chan string, len(files)) fileUploadErrors := make(chan error, len(files)) wg := sync.WaitGroup{} for _, file := range files { wg.Add(1) go func(file FileNewParams) { defer wg.Done() fileObj, err := filesService.New(ctx, file, opts...) if err != nil { fileUploadErrors <- err return } uploadedFileIDs <- fileObj.ID }(file) } wg.Wait() close(uploadedFileIDs) close(fileUploadErrors) for err := range fileUploadErrors { return nil, err } for id := range uploadedFileIDs { fileIDs = append(fileIDs, id) } return r.NewAndPoll(ctx, vectorStoreID, VectorStoreFileBatchNewParams{ FileIDs: fileIDs, }, pollIntervalMs, opts...) } // Retrieves a vector store file batch. func (r *VectorStoreFileBatchService) Get(ctx context.Context, vectorStoreID string, batchID string, opts ...option.RequestOption) (res *VectorStoreFileBatch, err error) { opts = slices.Concat(r.Options, opts) opts = append([]option.RequestOption{option.WithHeader("OpenAI-Beta", "assistants=v2")}, opts...) if vectorStoreID == "" { err = errors.New("missing required vector_store_id parameter") return nil, err } if batchID == "" { err = errors.New("missing required batch_id parameter") return nil, err } path := fmt.Sprintf("vector_stores/%s/file_batches/%s", vectorStoreID, batchID) err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...) return res, err } // Cancel a vector store file batch. This attempts to cancel the processing of // files in this batch as soon as possible. func (r *VectorStoreFileBatchService) Cancel(ctx context.Context, vectorStoreID string, batchID string, opts ...option.RequestOption) (res *VectorStoreFileBatch, err error) { opts = slices.Concat(r.Options, opts) opts = append([]option.RequestOption{option.WithHeader("OpenAI-Beta", "assistants=v2")}, opts...) if vectorStoreID == "" { err = errors.New("missing required vector_store_id parameter") return nil, err } if batchID == "" { err = errors.New("missing required batch_id parameter") return nil, err } path := fmt.Sprintf("vector_stores/%s/file_batches/%s/cancel", vectorStoreID, batchID) err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, nil, &res, opts...) return res, err } // Returns a list of vector store files in a batch. func (r *VectorStoreFileBatchService) ListFiles(ctx context.Context, vectorStoreID string, batchID string, query VectorStoreFileBatchListFilesParams, opts ...option.RequestOption) (res *pagination.CursorPage[VectorStoreFile], err error) { var raw *http.Response opts = slices.Concat(r.Options, opts) opts = append([]option.RequestOption{option.WithHeader("OpenAI-Beta", "assistants=v2"), option.WithResponseInto(&raw)}, opts...) if vectorStoreID == "" { err = errors.New("missing required vector_store_id parameter") return nil, err } if batchID == "" { err = errors.New("missing required batch_id parameter") return nil, err } path := fmt.Sprintf("vector_stores/%s/file_batches/%s/files", vectorStoreID, batchID) cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodGet, path, query, &res, opts...) if err != nil { return nil, err } err = cfg.Execute() if err != nil { return nil, err } res.SetPageConfig(cfg, raw) return res, nil } // Returns a list of vector store files in a batch. func (r *VectorStoreFileBatchService) ListFilesAutoPaging(ctx context.Context, vectorStoreID string, batchID string, query VectorStoreFileBatchListFilesParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[VectorStoreFile] { return pagination.NewCursorPageAutoPager(r.ListFiles(ctx, vectorStoreID, batchID, query, opts...)) } // A batch of files attached to a vector store. type VectorStoreFileBatch struct { // The identifier, which can be referenced in API endpoints. ID string `json:"id" api:"required"` // The Unix timestamp (in seconds) for when the vector store files batch was // created. CreatedAt int64 `json:"created_at" api:"required"` FileCounts VectorStoreFileBatchFileCounts `json:"file_counts" api:"required"` // The object type, which is always `vector_store.file_batch`. Object constant.VectorStoreFilesBatch `json:"object" default:"vector_store.files_batch"` // The status of the vector store files batch, which can be either `in_progress`, // `completed`, `cancelled` or `failed`. // // Any of "in_progress", "completed", "cancelled", "failed". Status VectorStoreFileBatchStatus `json:"status" api:"required"` // The ID of the // [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) // that the [File](https://platform.openai.com/docs/api-reference/files) is // attached to. VectorStoreID string `json:"vector_store_id" api:"required"` // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. JSON struct { ID respjson.Field CreatedAt respjson.Field FileCounts respjson.Field Object respjson.Field Status respjson.Field VectorStoreID respjson.Field ExtraFields map[string]respjson.Field raw string } `json:"-"` } // Returns the unmodified JSON received from the API func (r VectorStoreFileBatch) RawJSON() string { return r.JSON.raw } func (r *VectorStoreFileBatch) UnmarshalJSON(data []byte) error { return apijson.UnmarshalRoot(data, r) } type VectorStoreFileBatchFileCounts struct { // The number of files that where cancelled. Cancelled int64 `json:"cancelled" api:"required"` // The number of files that have been processed. Completed int64 `json:"completed" api:"required"` // The number of files that have failed to process. Failed int64 `json:"failed" api:"required"` // The number of files that are currently being processed. InProgress int64 `json:"in_progress" api:"required"` // The total number of files. Total int64 `json:"total" api:"required"` // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. JSON struct { Cancelled respjson.Field Completed respjson.Field Failed respjson.Field InProgress respjson.Field Total respjson.Field ExtraFields map[string]respjson.Field raw string } `json:"-"` } // Returns the unmodified JSON received from the API func (r VectorStoreFileBatchFileCounts) RawJSON() string { return r.JSON.raw } func (r *VectorStoreFileBatchFileCounts) UnmarshalJSON(data []byte) error { return apijson.UnmarshalRoot(data, r) } // The status of the vector store files batch, which can be either `in_progress`, // `completed`, `cancelled` or `failed`. type VectorStoreFileBatchStatus string const ( VectorStoreFileBatchStatusInProgress VectorStoreFileBatchStatus = "in_progress" VectorStoreFileBatchStatusCompleted VectorStoreFileBatchStatus = "completed" VectorStoreFileBatchStatusCancelled VectorStoreFileBatchStatus = "cancelled" VectorStoreFileBatchStatusFailed VectorStoreFileBatchStatus = "failed" ) type VectorStoreFileBatchNewParams struct { // 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. Attributes map[string]VectorStoreFileBatchNewParamsAttributeUnion `json:"attributes,omitzero"` // 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. ChunkingStrategy FileChunkingStrategyParamUnion `json:"chunking_strategy,omitzero"` // A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that // the vector store should use. Useful for tools like `file_search` that can access // files. If `attributes` or `chunking_strategy` are provided, they will be applied // to all files in the batch. The maximum batch size is 2000 files. Mutually // exclusive with `files`. FileIDs []string `json:"file_ids,omitzero"` // A list of objects that each include a `file_id` plus optional `attributes` or // `chunking_strategy`. Use this when you need to override metadata for specific // files. The global `attributes` or `chunking_strategy` will be ignored and must // be specified for each file. The maximum batch size is 2000 files. Mutually // exclusive with `file_ids`. Files []VectorStoreFileBatchNewParamsFile `json:"files,omitzero"` paramObj } func (r VectorStoreFileBatchNewParams) MarshalJSON() (data []byte, err error) { type shadow VectorStoreFileBatchNewParams return param.MarshalObject(r, (*shadow)(&r)) } func (r *VectorStoreFileBatchNewParams) UnmarshalJSON(data []byte) error { return apijson.UnmarshalRoot(data, r) } // Only one field can be non-zero. // // Use [param.IsOmitted] to confirm if a field is set. type VectorStoreFileBatchNewParamsAttributeUnion struct { OfString param.Opt[string] `json:",omitzero,inline"` OfFloat param.Opt[float64] `json:",omitzero,inline"` OfBool param.Opt[bool] `json:",omitzero,inline"` paramUnion } func (u VectorStoreFileBatchNewParamsAttributeUnion) MarshalJSON() ([]byte, error) { return param.MarshalUnion(u, u.OfString, u.OfFloat, u.OfBool) } func (u *VectorStoreFileBatchNewParamsAttributeUnion) UnmarshalJSON(data []byte) error { return apijson.UnmarshalRoot(data, u) } func (u *VectorStoreFileBatchNewParamsAttributeUnion) asAny() any { if !param.IsOmitted(u.OfString) { return &u.OfString.Value } else if !param.IsOmitted(u.OfFloat) { return &u.OfFloat.Value } else if !param.IsOmitted(u.OfBool) { return &u.OfBool.Value } return nil } // The property FileID is required. type VectorStoreFileBatchNewParamsFile struct { // A [File](https://platform.openai.com/docs/api-reference/files) ID that the // vector store should use. Useful for tools like `file_search` that can access // files. FileID string `json:"file_id" api:"required"` // 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. Attributes map[string]VectorStoreFileBatchNewParamsFileAttributeUnion `json:"attributes,omitzero"` // 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. ChunkingStrategy FileChunkingStrategyParamUnion `json:"chunking_strategy,omitzero"` paramObj } func (r VectorStoreFileBatchNewParamsFile) MarshalJSON() (data []byte, err error) { type shadow VectorStoreFileBatchNewParamsFile return param.MarshalObject(r, (*shadow)(&r)) } func (r *VectorStoreFileBatchNewParamsFile) UnmarshalJSON(data []byte) error { return apijson.UnmarshalRoot(data, r) } // Only one field can be non-zero. // // Use [param.IsOmitted] to confirm if a field is set. type VectorStoreFileBatchNewParamsFileAttributeUnion struct { OfString param.Opt[string] `json:",omitzero,inline"` OfFloat param.Opt[float64] `json:",omitzero,inline"` OfBool param.Opt[bool] `json:",omitzero,inline"` paramUnion } func (u VectorStoreFileBatchNewParamsFileAttributeUnion) MarshalJSON() ([]byte, error) { return param.MarshalUnion(u, u.OfString, u.OfFloat, u.OfBool) } func (u *VectorStoreFileBatchNewParamsFileAttributeUnion) UnmarshalJSON(data []byte) error { return apijson.UnmarshalRoot(data, u) } func (u *VectorStoreFileBatchNewParamsFileAttributeUnion) asAny() any { if !param.IsOmitted(u.OfString) { return &u.OfString.Value } else if !param.IsOmitted(u.OfFloat) { return &u.OfFloat.Value } else if !param.IsOmitted(u.OfBool) { return &u.OfBool.Value } return nil } type VectorStoreFileBatchListFilesParams struct { // 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. After param.Opt[string] `query:"after,omitzero" json:"-"` // 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. Before param.Opt[string] `query:"before,omitzero" json:"-"` // A limit on the number of objects to be returned. Limit can range between 1 and // 100, and the default is 20. Limit param.Opt[int64] `query:"limit,omitzero" json:"-"` // Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`. // // Any of "in_progress", "completed", "failed", "cancelled". Filter VectorStoreFileBatchListFilesParamsFilter `query:"filter,omitzero" json:"-"` // Sort order by the `created_at` timestamp of the objects. `asc` for ascending // order and `desc` for descending order. // // Any of "asc", "desc". Order VectorStoreFileBatchListFilesParamsOrder `query:"order,omitzero" json:"-"` paramObj } // URLQuery serializes [VectorStoreFileBatchListFilesParams]'s query parameters as // `url.Values`. func (r VectorStoreFileBatchListFilesParams) URLQuery() (v url.Values, err error) { return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{ ArrayFormat: apiquery.ArrayQueryFormatBrackets, NestedFormat: apiquery.NestedQueryFormatBrackets, }) } // Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`. type VectorStoreFileBatchListFilesParamsFilter string const ( VectorStoreFileBatchListFilesParamsFilterInProgress VectorStoreFileBatchListFilesParamsFilter = "in_progress" VectorStoreFileBatchListFilesParamsFilterCompleted VectorStoreFileBatchListFilesParamsFilter = "completed" VectorStoreFileBatchListFilesParamsFilterFailed VectorStoreFileBatchListFilesParamsFilter = "failed" VectorStoreFileBatchListFilesParamsFilterCancelled VectorStoreFileBatchListFilesParamsFilter = "cancelled" ) // Sort order by the `created_at` timestamp of the objects. `asc` for ascending // order and `desc` for descending order. type VectorStoreFileBatchListFilesParamsOrder string const ( VectorStoreFileBatchListFilesParamsOrderAsc VectorStoreFileBatchListFilesParamsOrder = "asc" VectorStoreFileBatchListFilesParamsOrderDesc VectorStoreFileBatchListFilesParamsOrder = "desc" )