openai.openai-go/vectorstore.go

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

package openai

import (
	"context"
	"errors"
	"fmt"
	"net/http"
	"net/url"
	"reflect"

	"github.com/openai/openai-go/internal/apijson"
	"github.com/openai/openai-go/internal/apiquery"
	"github.com/openai/openai-go/internal/param"
	"github.com/openai/openai-go/internal/requestconfig"
	"github.com/openai/openai-go/option"
	"github.com/openai/openai-go/packages/pagination"
	"github.com/openai/openai-go/shared"
	"github.com/tidwall/gjson"
)

// VectorStoreService 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 [NewVectorStoreService] method instead.
type VectorStoreService struct {
	Options     []option.RequestOption
	Files       *VectorStoreFileService
	FileBatches *VectorStoreFileBatchService
}

// NewVectorStoreService 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 NewVectorStoreService(opts ...option.RequestOption) (r *VectorStoreService) {
	r = &VectorStoreService{}
	r.Options = opts
	r.Files = NewVectorStoreFileService(opts...)
	r.FileBatches = NewVectorStoreFileBatchService(opts...)
	return
}

// Create a vector store.
func (r *VectorStoreService) New(ctx context.Context, body VectorStoreNewParams, opts ...option.RequestOption) (res *VectorStore, err error) {
	opts = append(r.Options[:], opts...)
	opts = append([]option.RequestOption{option.WithHeader("OpenAI-Beta", "assistants=v2")}, opts...)
	path := "vector_stores"
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
	return
}

// Retrieves a vector store.
func (r *VectorStoreService) Get(ctx context.Context, vectorStoreID string, opts ...option.RequestOption) (res *VectorStore, err error) {
	opts = append(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
	}
	path := fmt.Sprintf("vector_stores/%s", vectorStoreID)
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...)
	return
}

// Modifies a vector store.
func (r *VectorStoreService) Update(ctx context.Context, vectorStoreID string, body VectorStoreUpdateParams, opts ...option.RequestOption) (res *VectorStore, err error) {
	opts = append(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
	}
	path := fmt.Sprintf("vector_stores/%s", vectorStoreID)
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
	return
}

// Returns a list of vector stores.
func (r *VectorStoreService) List(ctx context.Context, query VectorStoreListParams, opts ...option.RequestOption) (res *pagination.CursorPage[VectorStore], err error) {
	var raw *http.Response
	opts = append(r.Options[:], opts...)
	opts = append([]option.RequestOption{option.WithHeader("OpenAI-Beta", "assistants=v2"), option.WithResponseInto(&raw)}, opts...)
	path := "vector_stores"
	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 stores.
func (r *VectorStoreService) ListAutoPaging(ctx context.Context, query VectorStoreListParams, opts ...option.RequestOption) *pagination.CursorPageAutoPager[VectorStore] {
	return pagination.NewCursorPageAutoPager(r.List(ctx, query, opts...))
}

// Delete a vector store.
func (r *VectorStoreService) Delete(ctx context.Context, vectorStoreID string, opts ...option.RequestOption) (res *VectorStoreDeleted, err error) {
	opts = append(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
	}
	path := fmt.Sprintf("vector_stores/%s", vectorStoreID)
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodDelete, path, nil, &res, opts...)
	return
}

// Search a vector store for relevant chunks based on a query and file attributes
// filter.
func (r *VectorStoreService) Search(ctx context.Context, vectorStoreID string, body VectorStoreSearchParams, opts ...option.RequestOption) (res *pagination.Page[VectorStoreSearchResponse], err error) {
	var raw *http.Response
	opts = append(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
	}
	path := fmt.Sprintf("vector_stores/%s/search", vectorStoreID)
	cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodPost, path, body, &res, opts...)
	if err != nil {
		return nil, err
	}
	err = cfg.Execute()
	if err != nil {
		return nil, err
	}
	res.SetPageConfig(cfg, raw)
	return res, nil
}

// Search a vector store for relevant chunks based on a query and file attributes
// filter.
func (r *VectorStoreService) SearchAutoPaging(ctx context.Context, vectorStoreID string, body VectorStoreSearchParams, opts ...option.RequestOption) *pagination.PageAutoPager[VectorStoreSearchResponse] {
	return pagination.NewPageAutoPager(r.Search(ctx, vectorStoreID, body, opts...))
}

// The default strategy. This strategy currently uses a `max_chunk_size_tokens` of
// `800` and `chunk_overlap_tokens` of `400`.
type AutoFileChunkingStrategyParam struct {
	// Always `auto`.
	Type param.Field[AutoFileChunkingStrategyParamType] `json:"type,required"`
}

func (r AutoFileChunkingStrategyParam) MarshalJSON() (data []byte, err error) {
	return apijson.MarshalRoot(r)
}

func (r AutoFileChunkingStrategyParam) implementsFileChunkingStrategyParamUnion() {}

// Always `auto`.
type AutoFileChunkingStrategyParamType string

const (
	AutoFileChunkingStrategyParamTypeAuto AutoFileChunkingStrategyParamType = "auto"
)

func (r AutoFileChunkingStrategyParamType) IsKnown() bool {
	switch r {
	case AutoFileChunkingStrategyParamTypeAuto:
		return true
	}
	return false
}

// The strategy used to chunk the file.
type FileChunkingStrategy struct {
	// Always `static`.
	Type   FileChunkingStrategyType   `json:"type,required"`
	Static StaticFileChunkingStrategy `json:"static"`
	JSON   fileChunkingStrategyJSON   `json:"-"`
	union  FileChunkingStrategyUnion
}

// fileChunkingStrategyJSON contains the JSON metadata for the struct
// [FileChunkingStrategy]
type fileChunkingStrategyJSON struct {
	Type        apijson.Field
	Static      apijson.Field
	raw         string
	ExtraFields map[string]apijson.Field
}

func (r fileChunkingStrategyJSON) RawJSON() string {
	return r.raw
}

func (r *FileChunkingStrategy) UnmarshalJSON(data []byte) (err error) {
	*r = FileChunkingStrategy{}
	err = apijson.UnmarshalRoot(data, &r.union)
	if err != nil {
		return err
	}
	return apijson.Port(r.union, &r)
}

// AsUnion returns a [FileChunkingStrategyUnion] interface which you can cast to
// the specific types for more type safety.
//
// Possible runtime types of the union are [StaticFileChunkingStrategyObject],
// [OtherFileChunkingStrategyObject].
func (r FileChunkingStrategy) AsUnion() FileChunkingStrategyUnion {
	return r.union
}

// The strategy used to chunk the file.
//
// Union satisfied by [StaticFileChunkingStrategyObject] or
// [OtherFileChunkingStrategyObject].
type FileChunkingStrategyUnion interface {
	implementsFileChunkingStrategy()
}

func init() {
	apijson.RegisterUnion(
		reflect.TypeOf((*FileChunkingStrategyUnion)(nil)).Elem(),
		"type",
		apijson.UnionVariant{
			TypeFilter:         gjson.JSON,
			Type:               reflect.TypeOf(StaticFileChunkingStrategyObject{}),
			DiscriminatorValue: "static",
		},
		apijson.UnionVariant{
			TypeFilter:         gjson.JSON,
			Type:               reflect.TypeOf(OtherFileChunkingStrategyObject{}),
			DiscriminatorValue: "other",
		},
	)
}

// Always `static`.
type FileChunkingStrategyType string

const (
	FileChunkingStrategyTypeStatic FileChunkingStrategyType = "static"
	FileChunkingStrategyTypeOther  FileChunkingStrategyType = "other"
)

func (r FileChunkingStrategyType) IsKnown() bool {
	switch r {
	case FileChunkingStrategyTypeStatic, FileChunkingStrategyTypeOther:
		return true
	}
	return false
}

// 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.
type FileChunkingStrategyParam struct {
	// Always `auto`.
	Type   param.Field[FileChunkingStrategyParamType]   `json:"type,required"`
	Static param.Field[StaticFileChunkingStrategyParam] `json:"static"`
}

func (r FileChunkingStrategyParam) MarshalJSON() (data []byte, err error) {
	return apijson.MarshalRoot(r)
}

func (r FileChunkingStrategyParam) implementsFileChunkingStrategyParamUnion() {}

// 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.
//
// Satisfied by [AutoFileChunkingStrategyParam],
// [StaticFileChunkingStrategyObjectParam], [FileChunkingStrategyParam].
type FileChunkingStrategyParamUnion interface {
	implementsFileChunkingStrategyParamUnion()
}

// Always `auto`.
type FileChunkingStrategyParamType string

const (
	FileChunkingStrategyParamTypeAuto   FileChunkingStrategyParamType = "auto"
	FileChunkingStrategyParamTypeStatic FileChunkingStrategyParamType = "static"
)

func (r FileChunkingStrategyParamType) IsKnown() bool {
	switch r {
	case FileChunkingStrategyParamTypeAuto, FileChunkingStrategyParamTypeStatic:
		return true
	}
	return false
}

// 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 OtherFileChunkingStrategyObject struct {
	// Always `other`.
	Type OtherFileChunkingStrategyObjectType `json:"type,required"`
	JSON otherFileChunkingStrategyObjectJSON `json:"-"`
}

// otherFileChunkingStrategyObjectJSON contains the JSON metadata for the struct
// [OtherFileChunkingStrategyObject]
type otherFileChunkingStrategyObjectJSON struct {
	Type        apijson.Field
	raw         string
	ExtraFields map[string]apijson.Field
}

func (r *OtherFileChunkingStrategyObject) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r otherFileChunkingStrategyObjectJSON) RawJSON() string {
	return r.raw
}

func (r OtherFileChunkingStrategyObject) implementsFileChunkingStrategy() {}

// Always `other`.
type OtherFileChunkingStrategyObjectType string

const (
	OtherFileChunkingStrategyObjectTypeOther OtherFileChunkingStrategyObjectType = "other"
)

func (r OtherFileChunkingStrategyObjectType) IsKnown() bool {
	switch r {
	case OtherFileChunkingStrategyObjectTypeOther:
		return true
	}
	return false
}

type StaticFileChunkingStrategy struct {
	// 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`.
	ChunkOverlapTokens int64 `json:"chunk_overlap_tokens,required"`
	// The maximum number of tokens in each chunk. The default value is `800`. The
	// minimum value is `100` and the maximum value is `4096`.
	MaxChunkSizeTokens int64                          `json:"max_chunk_size_tokens,required"`
	JSON               staticFileChunkingStrategyJSON `json:"-"`
}

// staticFileChunkingStrategyJSON contains the JSON metadata for the struct
// [StaticFileChunkingStrategy]
type staticFileChunkingStrategyJSON struct {
	ChunkOverlapTokens apijson.Field
	MaxChunkSizeTokens apijson.Field
	raw                string
	ExtraFields        map[string]apijson.Field
}

func (r *StaticFileChunkingStrategy) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r staticFileChunkingStrategyJSON) RawJSON() string {
	return r.raw
}

type StaticFileChunkingStrategyParam struct {
	// 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`.
	ChunkOverlapTokens param.Field[int64] `json:"chunk_overlap_tokens,required"`
	// The maximum number of tokens in each chunk. The default value is `800`. The
	// minimum value is `100` and the maximum value is `4096`.
	MaxChunkSizeTokens param.Field[int64] `json:"max_chunk_size_tokens,required"`
}

func (r StaticFileChunkingStrategyParam) MarshalJSON() (data []byte, err error) {
	return apijson.MarshalRoot(r)
}

type StaticFileChunkingStrategyObject struct {
	Static StaticFileChunkingStrategy `json:"static,required"`
	// Always `static`.
	Type StaticFileChunkingStrategyObjectType `json:"type,required"`
	JSON staticFileChunkingStrategyObjectJSON `json:"-"`
}

// staticFileChunkingStrategyObjectJSON contains the JSON metadata for the struct
// [StaticFileChunkingStrategyObject]
type staticFileChunkingStrategyObjectJSON struct {
	Static      apijson.Field
	Type        apijson.Field
	raw         string
	ExtraFields map[string]apijson.Field
}

func (r *StaticFileChunkingStrategyObject) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r staticFileChunkingStrategyObjectJSON) RawJSON() string {
	return r.raw
}

func (r StaticFileChunkingStrategyObject) implementsFileChunkingStrategy() {}

// Always `static`.
type StaticFileChunkingStrategyObjectType string

const (
	StaticFileChunkingStrategyObjectTypeStatic StaticFileChunkingStrategyObjectType = "static"
)

func (r StaticFileChunkingStrategyObjectType) IsKnown() bool {
	switch r {
	case StaticFileChunkingStrategyObjectTypeStatic:
		return true
	}
	return false
}

// Customize your own chunking strategy by setting chunk size and chunk overlap.
type StaticFileChunkingStrategyObjectParam struct {
	Static param.Field[StaticFileChunkingStrategyParam] `json:"static,required"`
	// Always `static`.
	Type param.Field[StaticFileChunkingStrategyObjectParamType] `json:"type,required"`
}

func (r StaticFileChunkingStrategyObjectParam) MarshalJSON() (data []byte, err error) {
	return apijson.MarshalRoot(r)
}

func (r StaticFileChunkingStrategyObjectParam) implementsFileChunkingStrategyParamUnion() {}

// Always `static`.
type StaticFileChunkingStrategyObjectParamType string

const (
	StaticFileChunkingStrategyObjectParamTypeStatic StaticFileChunkingStrategyObjectParamType = "static"
)

func (r StaticFileChunkingStrategyObjectParamType) IsKnown() bool {
	switch r {
	case StaticFileChunkingStrategyObjectParamTypeStatic:
		return true
	}
	return false
}

// A vector store is a collection of processed files can be used by the
// `file_search` tool.
type VectorStore struct {
	// The identifier, which can be referenced in API endpoints.
	ID string `json:"id,required"`
	// The Unix timestamp (in seconds) for when the vector store was created.
	CreatedAt  int64                 `json:"created_at,required"`
	FileCounts VectorStoreFileCounts `json:"file_counts,required"`
	// The Unix timestamp (in seconds) for when the vector store was last active.
	LastActiveAt int64 `json:"last_active_at,required,nullable"`
	// 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.
	Metadata shared.Metadata `json:"metadata,required,nullable"`
	// The name of the vector store.
	Name string `json:"name,required"`
	// The object type, which is always `vector_store`.
	Object VectorStoreObject `json:"object,required"`
	// The status of the vector store, which can be either `expired`, `in_progress`, or
	// `completed`. A status of `completed` indicates that the vector store is ready
	// for use.
	Status VectorStoreStatus `json:"status,required"`
	// The total number of bytes used by the files in the vector store.
	UsageBytes int64 `json:"usage_bytes,required"`
	// The expiration policy for a vector store.
	ExpiresAfter VectorStoreExpiresAfter `json:"expires_after"`
	// The Unix timestamp (in seconds) for when the vector store will expire.
	ExpiresAt int64           `json:"expires_at,nullable"`
	JSON      vectorStoreJSON `json:"-"`
}

// vectorStoreJSON contains the JSON metadata for the struct [VectorStore]
type vectorStoreJSON struct {
	ID           apijson.Field
	CreatedAt    apijson.Field
	FileCounts   apijson.Field
	LastActiveAt apijson.Field
	Metadata     apijson.Field
	Name         apijson.Field
	Object       apijson.Field
	Status       apijson.Field
	UsageBytes   apijson.Field
	ExpiresAfter apijson.Field
	ExpiresAt    apijson.Field
	raw          string
	ExtraFields  map[string]apijson.Field
}

func (r *VectorStore) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r vectorStoreJSON) RawJSON() string {
	return r.raw
}

type VectorStoreFileCounts struct {
	// The number of files that were cancelled.
	Cancelled int64 `json:"cancelled,required"`
	// The number of files that have been successfully processed.
	Completed int64 `json:"completed,required"`
	// The number of files that have failed to process.
	Failed int64 `json:"failed,required"`
	// The number of files that are currently being processed.
	InProgress int64 `json:"in_progress,required"`
	// The total number of files.
	Total int64                     `json:"total,required"`
	JSON  vectorStoreFileCountsJSON `json:"-"`
}

// vectorStoreFileCountsJSON contains the JSON metadata for the struct
// [VectorStoreFileCounts]
type vectorStoreFileCountsJSON struct {
	Cancelled   apijson.Field
	Completed   apijson.Field
	Failed      apijson.Field
	InProgress  apijson.Field
	Total       apijson.Field
	raw         string
	ExtraFields map[string]apijson.Field
}

func (r *VectorStoreFileCounts) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r vectorStoreFileCountsJSON) RawJSON() string {
	return r.raw
}

// The object type, which is always `vector_store`.
type VectorStoreObject string

const (
	VectorStoreObjectVectorStore VectorStoreObject = "vector_store"
)

func (r VectorStoreObject) IsKnown() bool {
	switch r {
	case VectorStoreObjectVectorStore:
		return true
	}
	return false
}

// The status of the vector store, which can be either `expired`, `in_progress`, or
// `completed`. A status of `completed` indicates that the vector store is ready
// for use.
type VectorStoreStatus string

const (
	VectorStoreStatusExpired    VectorStoreStatus = "expired"
	VectorStoreStatusInProgress VectorStoreStatus = "in_progress"
	VectorStoreStatusCompleted  VectorStoreStatus = "completed"
)

func (r VectorStoreStatus) IsKnown() bool {
	switch r {
	case VectorStoreStatusExpired, VectorStoreStatusInProgress, VectorStoreStatusCompleted:
		return true
	}
	return false
}

// The expiration policy for a vector store.
type VectorStoreExpiresAfter struct {
	// Anchor timestamp after which the expiration policy applies. Supported anchors:
	// `last_active_at`.
	Anchor VectorStoreExpiresAfterAnchor `json:"anchor,required"`
	// The number of days after the anchor time that the vector store will expire.
	Days int64                       `json:"days,required"`
	JSON vectorStoreExpiresAfterJSON `json:"-"`
}

// vectorStoreExpiresAfterJSON contains the JSON metadata for the struct
// [VectorStoreExpiresAfter]
type vectorStoreExpiresAfterJSON struct {
	Anchor      apijson.Field
	Days        apijson.Field
	raw         string
	ExtraFields map[string]apijson.Field
}

func (r *VectorStoreExpiresAfter) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r vectorStoreExpiresAfterJSON) RawJSON() string {
	return r.raw
}

// Anchor timestamp after which the expiration policy applies. Supported anchors:
// `last_active_at`.
type VectorStoreExpiresAfterAnchor string

const (
	VectorStoreExpiresAfterAnchorLastActiveAt VectorStoreExpiresAfterAnchor = "last_active_at"
)

func (r VectorStoreExpiresAfterAnchor) IsKnown() bool {
	switch r {
	case VectorStoreExpiresAfterAnchorLastActiveAt:
		return true
	}
	return false
}

type VectorStoreDeleted struct {
	ID      string                   `json:"id,required"`
	Deleted bool                     `json:"deleted,required"`
	Object  VectorStoreDeletedObject `json:"object,required"`
	JSON    vectorStoreDeletedJSON   `json:"-"`
}

// vectorStoreDeletedJSON contains the JSON metadata for the struct
// [VectorStoreDeleted]
type vectorStoreDeletedJSON struct {
	ID          apijson.Field
	Deleted     apijson.Field
	Object      apijson.Field
	raw         string
	ExtraFields map[string]apijson.Field
}

func (r *VectorStoreDeleted) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r vectorStoreDeletedJSON) RawJSON() string {
	return r.raw
}

type VectorStoreDeletedObject string

const (
	VectorStoreDeletedObjectVectorStoreDeleted VectorStoreDeletedObject = "vector_store.deleted"
)

func (r VectorStoreDeletedObject) IsKnown() bool {
	switch r {
	case VectorStoreDeletedObjectVectorStoreDeleted:
		return true
	}
	return false
}

type VectorStoreSearchResponse 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]VectorStoreSearchResponseAttributesUnion `json:"attributes,required,nullable"`
	// Content chunks from the file.
	Content []VectorStoreSearchResponseContent `json:"content,required"`
	// The ID of the vector store file.
	FileID string `json:"file_id,required"`
	// The name of the vector store file.
	Filename string `json:"filename,required"`
	// The similarity score for the result.
	Score float64                       `json:"score,required"`
	JSON  vectorStoreSearchResponseJSON `json:"-"`
}

// vectorStoreSearchResponseJSON contains the JSON metadata for the struct
// [VectorStoreSearchResponse]
type vectorStoreSearchResponseJSON struct {
	Attributes  apijson.Field
	Content     apijson.Field
	FileID      apijson.Field
	Filename    apijson.Field
	Score       apijson.Field
	raw         string
	ExtraFields map[string]apijson.Field
}

func (r *VectorStoreSearchResponse) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r vectorStoreSearchResponseJSON) RawJSON() string {
	return r.raw
}

// Union satisfied by [shared.UnionString], [shared.UnionFloat] or
// [shared.UnionBool].
type VectorStoreSearchResponseAttributesUnion interface {
	ImplementsVectorStoreSearchResponseAttributesUnion()
}

func init() {
	apijson.RegisterUnion(
		reflect.TypeOf((*VectorStoreSearchResponseAttributesUnion)(nil)).Elem(),
		"",
		apijson.UnionVariant{
			TypeFilter: gjson.String,
			Type:       reflect.TypeOf(shared.UnionString("")),
		},
		apijson.UnionVariant{
			TypeFilter: gjson.Number,
			Type:       reflect.TypeOf(shared.UnionFloat(0)),
		},
		apijson.UnionVariant{
			TypeFilter: gjson.True,
			Type:       reflect.TypeOf(shared.UnionBool(false)),
		},
		apijson.UnionVariant{
			TypeFilter: gjson.False,
			Type:       reflect.TypeOf(shared.UnionBool(false)),
		},
	)
}

type VectorStoreSearchResponseContent struct {
	// The text content returned from search.
	Text string `json:"text,required"`
	// The type of content.
	Type VectorStoreSearchResponseContentType `json:"type,required"`
	JSON vectorStoreSearchResponseContentJSON `json:"-"`
}

// vectorStoreSearchResponseContentJSON contains the JSON metadata for the struct
// [VectorStoreSearchResponseContent]
type vectorStoreSearchResponseContentJSON struct {
	Text        apijson.Field
	Type        apijson.Field
	raw         string
	ExtraFields map[string]apijson.Field
}

func (r *VectorStoreSearchResponseContent) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r vectorStoreSearchResponseContentJSON) RawJSON() string {
	return r.raw
}

// The type of content.
type VectorStoreSearchResponseContentType string

const (
	VectorStoreSearchResponseContentTypeText VectorStoreSearchResponseContentType = "text"
)

func (r VectorStoreSearchResponseContentType) IsKnown() bool {
	switch r {
	case VectorStoreSearchResponseContentTypeText:
		return true
	}
	return false
}

type VectorStoreNewParams struct {
	// 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 param.Field[FileChunkingStrategyParamUnion] `json:"chunking_strategy"`
	// The expiration policy for a vector store.
	ExpiresAfter param.Field[VectorStoreNewParamsExpiresAfter] `json:"expires_after"`
	// 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.
	FileIDs param.Field[[]string] `json:"file_ids"`
	// 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.
	Metadata param.Field[shared.MetadataParam] `json:"metadata"`
	// The name of the vector store.
	Name param.Field[string] `json:"name"`
}

func (r VectorStoreNewParams) MarshalJSON() (data []byte, err error) {
	return apijson.MarshalRoot(r)
}

// The expiration policy for a vector store.
type VectorStoreNewParamsExpiresAfter struct {
	// Anchor timestamp after which the expiration policy applies. Supported anchors:
	// `last_active_at`.
	Anchor param.Field[VectorStoreNewParamsExpiresAfterAnchor] `json:"anchor,required"`
	// The number of days after the anchor time that the vector store will expire.
	Days param.Field[int64] `json:"days,required"`
}

func (r VectorStoreNewParamsExpiresAfter) MarshalJSON() (data []byte, err error) {
	return apijson.MarshalRoot(r)
}

// Anchor timestamp after which the expiration policy applies. Supported anchors:
// `last_active_at`.
type VectorStoreNewParamsExpiresAfterAnchor string

const (
	VectorStoreNewParamsExpiresAfterAnchorLastActiveAt VectorStoreNewParamsExpiresAfterAnchor = "last_active_at"
)

func (r VectorStoreNewParamsExpiresAfterAnchor) IsKnown() bool {
	switch r {
	case VectorStoreNewParamsExpiresAfterAnchorLastActiveAt:
		return true
	}
	return false
}

type VectorStoreUpdateParams struct {
	// The expiration policy for a vector store.
	ExpiresAfter param.Field[VectorStoreUpdateParamsExpiresAfter] `json:"expires_after"`
	// 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.
	Metadata param.Field[shared.MetadataParam] `json:"metadata"`
	// The name of the vector store.
	Name param.Field[string] `json:"name"`
}

func (r VectorStoreUpdateParams) MarshalJSON() (data []byte, err error) {
	return apijson.MarshalRoot(r)
}

// The expiration policy for a vector store.
type VectorStoreUpdateParamsExpiresAfter struct {
	// Anchor timestamp after which the expiration policy applies. Supported anchors:
	// `last_active_at`.
	Anchor param.Field[VectorStoreUpdateParamsExpiresAfterAnchor] `json:"anchor,required"`
	// The number of days after the anchor time that the vector store will expire.
	Days param.Field[int64] `json:"days,required"`
}

func (r VectorStoreUpdateParamsExpiresAfter) MarshalJSON() (data []byte, err error) {
	return apijson.MarshalRoot(r)
}

// Anchor timestamp after which the expiration policy applies. Supported anchors:
// `last_active_at`.
type VectorStoreUpdateParamsExpiresAfterAnchor string

const (
	VectorStoreUpdateParamsExpiresAfterAnchorLastActiveAt VectorStoreUpdateParamsExpiresAfterAnchor = "last_active_at"
)

func (r VectorStoreUpdateParamsExpiresAfterAnchor) IsKnown() bool {
	switch r {
	case VectorStoreUpdateParamsExpiresAfterAnchorLastActiveAt:
		return true
	}
	return false
}

type VectorStoreListParams 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.Field[string] `query:"after"`
	// 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.Field[string] `query:"before"`
	// A limit on the number of objects to be returned. Limit can range between 1 and
	// 100, and the default is 20.
	Limit param.Field[int64] `query:"limit"`
	// Sort order by the `created_at` timestamp of the objects. `asc` for ascending
	// order and `desc` for descending order.
	Order param.Field[VectorStoreListParamsOrder] `query:"order"`
}

// URLQuery serializes [VectorStoreListParams]'s query parameters as `url.Values`.
func (r VectorStoreListParams) URLQuery() (v url.Values) {
	return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
		ArrayFormat:  apiquery.ArrayQueryFormatBrackets,
		NestedFormat: apiquery.NestedQueryFormatBrackets,
	})
}

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

const (
	VectorStoreListParamsOrderAsc  VectorStoreListParamsOrder = "asc"
	VectorStoreListParamsOrderDesc VectorStoreListParamsOrder = "desc"
)

func (r VectorStoreListParamsOrder) IsKnown() bool {
	switch r {
	case VectorStoreListParamsOrderAsc, VectorStoreListParamsOrderDesc:
		return true
	}
	return false
}

type VectorStoreSearchParams struct {
	// A query string for a search
	Query param.Field[VectorStoreSearchParamsQueryUnion] `json:"query,required"`
	// A filter to apply based on file attributes.
	Filters param.Field[VectorStoreSearchParamsFiltersUnion] `json:"filters"`
	// The maximum number of results to return. This number should be between 1 and 50
	// inclusive.
	MaxNumResults param.Field[int64] `json:"max_num_results"`
	// Ranking options for search.
	RankingOptions param.Field[VectorStoreSearchParamsRankingOptions] `json:"ranking_options"`
	// Whether to rewrite the natural language query for vector search.
	RewriteQuery param.Field[bool] `json:"rewrite_query"`
}

func (r VectorStoreSearchParams) MarshalJSON() (data []byte, err error) {
	return apijson.MarshalRoot(r)
}

// A query string for a search
//
// Satisfied by [shared.UnionString], [VectorStoreSearchParamsQueryArray].
type VectorStoreSearchParamsQueryUnion interface {
	ImplementsVectorStoreSearchParamsQueryUnion()
}

type VectorStoreSearchParamsQueryArray []string

func (r VectorStoreSearchParamsQueryArray) ImplementsVectorStoreSearchParamsQueryUnion() {}

// A filter to apply based on file attributes.
type VectorStoreSearchParamsFilters struct {
	// Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`.
	//
	// - `eq`: equals
	// - `ne`: not equal
	// - `gt`: greater than
	// - `gte`: greater than or equal
	// - `lt`: less than
	// - `lte`: less than or equal
	Type    param.Field[VectorStoreSearchParamsFiltersType] `json:"type,required"`
	Filters param.Field[interface{}]                        `json:"filters"`
	// The key to compare against the value.
	Key   param.Field[string]      `json:"key"`
	Value param.Field[interface{}] `json:"value"`
}

func (r VectorStoreSearchParamsFilters) MarshalJSON() (data []byte, err error) {
	return apijson.MarshalRoot(r)
}

func (r VectorStoreSearchParamsFilters) ImplementsVectorStoreSearchParamsFiltersUnion() {}

// A filter to apply based on file attributes.
//
// Satisfied by [shared.ComparisonFilterParam], [shared.CompoundFilterParam],
// [VectorStoreSearchParamsFilters].
type VectorStoreSearchParamsFiltersUnion interface {
	ImplementsVectorStoreSearchParamsFiltersUnion()
}

// Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`.
//
// - `eq`: equals
// - `ne`: not equal
// - `gt`: greater than
// - `gte`: greater than or equal
// - `lt`: less than
// - `lte`: less than or equal
type VectorStoreSearchParamsFiltersType string

const (
	VectorStoreSearchParamsFiltersTypeEq  VectorStoreSearchParamsFiltersType = "eq"
	VectorStoreSearchParamsFiltersTypeNe  VectorStoreSearchParamsFiltersType = "ne"
	VectorStoreSearchParamsFiltersTypeGt  VectorStoreSearchParamsFiltersType = "gt"
	VectorStoreSearchParamsFiltersTypeGte VectorStoreSearchParamsFiltersType = "gte"
	VectorStoreSearchParamsFiltersTypeLt  VectorStoreSearchParamsFiltersType = "lt"
	VectorStoreSearchParamsFiltersTypeLte VectorStoreSearchParamsFiltersType = "lte"
	VectorStoreSearchParamsFiltersTypeAnd VectorStoreSearchParamsFiltersType = "and"
	VectorStoreSearchParamsFiltersTypeOr  VectorStoreSearchParamsFiltersType = "or"
)

func (r VectorStoreSearchParamsFiltersType) IsKnown() bool {
	switch r {
	case VectorStoreSearchParamsFiltersTypeEq, VectorStoreSearchParamsFiltersTypeNe, VectorStoreSearchParamsFiltersTypeGt, VectorStoreSearchParamsFiltersTypeGte, VectorStoreSearchParamsFiltersTypeLt, VectorStoreSearchParamsFiltersTypeLte, VectorStoreSearchParamsFiltersTypeAnd, VectorStoreSearchParamsFiltersTypeOr:
		return true
	}
	return false
}

// Ranking options for search.
type VectorStoreSearchParamsRankingOptions struct {
	Ranker         param.Field[VectorStoreSearchParamsRankingOptionsRanker] `json:"ranker"`
	ScoreThreshold param.Field[float64]                                     `json:"score_threshold"`
}

func (r VectorStoreSearchParamsRankingOptions) MarshalJSON() (data []byte, err error) {
	return apijson.MarshalRoot(r)
}

type VectorStoreSearchParamsRankingOptionsRanker string

const (
	VectorStoreSearchParamsRankingOptionsRankerAuto              VectorStoreSearchParamsRankingOptionsRanker = "auto"
	VectorStoreSearchParamsRankingOptionsRankerDefault2024_11_15 VectorStoreSearchParamsRankingOptionsRanker = "default-2024-11-15"
)

func (r VectorStoreSearchParamsRankingOptionsRanker) IsKnown() bool {
	switch r {
	case VectorStoreSearchParamsRankingOptionsRankerAuto, VectorStoreSearchParamsRankingOptionsRankerDefault2024_11_15:
		return true
	}
	return false
}