turbopuffer

type AggregateBy interface {
	// contains filtered or unexported methods
}

type AggregateByCount struct {
}

type AggregateBySum struct {
	// contains filtered or unexported fields
}

type AggregationGroup map[string]any

type AttributeSchemaConfig struct {
	// The data type of the attribute. Valid values: string, int, uint, float, uuid,
	// datetime, bool, []string, []int, []uint, []float, []uuid, []datetime, []bool,
	// [DIMS]f16, [DIMS]f32.
	Type AttributeType `json:"type" api:"required"`
	// Whether to create an approximate nearest neighbor index for the attribute. Can
	// be a boolean or a detailed configuration object.
	Ann AttributeSchemaConfigAnn `json:"ann"`
	// Whether or not the attributes can be used in filters.
	Filterable bool `json:"filterable"`
	// Whether this attribute can be used as part of a BM25 full-text search. Requires
	// the `string` or `[]string` type, and by default, BM25-enabled attributes are not
	// filterable. You can override this by setting `filterable: true`.
	FullTextSearch FullTextSearchConfig `json:"full_text_search"`
	// Whether to enable Glob filters on this attribute.
	Glob bool `json:"glob"`
	// Whether to enable Regex filters on this attribute.
	Regex bool `json:"regex"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Type           respjson.Field
		Ann            respjson.Field
		Filterable     respjson.Field
		FullTextSearch respjson.Field
		Glob           respjson.Field
		Regex          respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type AttributeSchemaConfigAnn struct {
	// A function used to calculate vector similarity.
	//
	// Any of "cosine_distance", "euclidean_squared".
	DistanceMetric DistanceMetric `json:"distance_metric"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		DistanceMetric respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type AttributeSchemaConfigAnnParam struct {
	// A function used to calculate vector similarity.
	//
	// Any of "cosine_distance", "euclidean_squared".
	DistanceMetric DistanceMetric `json:"distance_metric,omitzero"`
	// contains filtered or unexported fields
}

type AttributeSchemaConfigParam struct {
	// The data type of the attribute. Valid values: string, int, uint, float, uuid,
	// datetime, bool, []string, []int, []uint, []float, []uuid, []datetime, []bool,
	// [DIMS]f16, [DIMS]f32.
	Type AttributeType `json:"type" api:"required"`
	// Whether or not the attributes can be used in filters.
	Filterable param.Opt[bool] `json:"filterable,omitzero"`
	// Whether to enable Glob filters on this attribute.
	Glob param.Opt[bool] `json:"glob,omitzero"`
	// Whether to enable Regex filters on this attribute.
	Regex param.Opt[bool] `json:"regex,omitzero"`
	// Whether to create an approximate nearest neighbor index for the attribute. Can
	// be a boolean or a detailed configuration object.
	Ann AttributeSchemaConfigAnnParam `json:"ann,omitzero"`
	// Whether this attribute can be used as part of a BM25 full-text search. Requires
	// the `string` or `[]string` type, and by default, BM25-enabled attributes are not
	// filterable. You can override this by setting `filterable: true`.
	FullTextSearch *FullTextSearchConfigParam `json:"full_text_search,omitzero"`
	// contains filtered or unexported fields
}

type AttributeType = string

type Bm25ClauseParams struct {
	// Whether to treat the last token in the query input as a literal prefix.
	LastAsPrefix param.Opt[bool] `json:"last_as_prefix,omitzero"`
	// contains filtered or unexported fields
}

type BranchFromNamespaceParams struct {
	// The namespace to create an instant, copy-on-write clone of.
	SourceNamespace string `json:"source_namespace" api:"required"`
	// contains filtered or unexported fields
}

type Client struct {
	Options []option.RequestOption
	// contains filtered or unexported fields
}

type ColumnsParam map[string][]any

type ContainsAllTokensFilterParams struct {
	// Whether to treat the last token in the query input as a literal prefix.
	LastAsPrefix param.Opt[bool] `json:"last_as_prefix,omitzero"`
	// contains filtered or unexported fields
}

type ContainsAnyTokenFilterParams struct {
	// Whether to treat the last token in the query input as a literal prefix.
	LastAsPrefix param.Opt[bool] `json:"last_as_prefix,omitzero"`
	// contains filtered or unexported fields
}

type CopyFromNamespaceParams struct {
	// The namespace to copy documents from.
	SourceNamespace string `json:"source_namespace" api:"required"`
	// (Optional) An API key for the organization containing the source namespace
	SourceAPIKey param.Opt[string] `json:"source_api_key,omitzero"`
	// (Optional) The region of the source namespace.
	SourceRegion param.Opt[string] `json:"source_region,omitzero"`
	// contains filtered or unexported fields
}

type DecayParams struct {
	// An exponent that helps further control the shape of the Decay function.
	Exponent param.Opt[float64] `json:"exponent,omitzero"`
	// The midpoint of the Decay operator.
	Midpoint any `json:"midpoint,omitzero"`
	// contains filtered or unexported fields
}

type DistanceMetric string

type Error = apierror.Error

type Expr interface {
	// contains filtered or unexported methods
}

type ExprRefNew struct {
	// contains filtered or unexported fields
}

type Filter interface {
	// contains filtered or unexported methods
}

type FilterAnd struct {
	// contains filtered or unexported fields
}

type FilterAnyGt struct {
	// contains filtered or unexported fields
}

type FilterAnyGte struct {
	// contains filtered or unexported fields
}

type FilterAnyLt struct {
	// contains filtered or unexported fields
}

type FilterAnyLte struct {
	// contains filtered or unexported fields
}

type FilterContains struct {
	// contains filtered or unexported fields
}

type FilterContainsAllTokens struct {
	// contains filtered or unexported fields
}

type FilterContainsAllTokensArray struct {
	// contains filtered or unexported fields
}

type FilterContainsAllTokensArrayWithParams struct {
	// contains filtered or unexported fields
}

type FilterContainsAllTokensWithParams struct {
	// contains filtered or unexported fields
}

type FilterContainsAny[T any] struct {
	// contains filtered or unexported fields
}

type FilterContainsAnyToken struct {
	// contains filtered or unexported fields
}

type FilterContainsAnyTokenArray struct {
	// contains filtered or unexported fields
}

type FilterContainsAnyTokenArrayWithParams struct {
	// contains filtered or unexported fields
}

type FilterContainsAnyTokenWithParams struct {
	// contains filtered or unexported fields
}

type FilterContainsTokenSequence struct {
	// contains filtered or unexported fields
}

type FilterContainsTokenSequenceArray struct {
	// contains filtered or unexported fields
}

type FilterEq struct {
	// contains filtered or unexported fields
}

type FilterGlob struct {
	// contains filtered or unexported fields
}

type FilterGt struct {
	// contains filtered or unexported fields
}

type FilterGte struct {
	// contains filtered or unexported fields
}

type FilterIGlob struct {
	// contains filtered or unexported fields
}

type FilterIn[T any] struct {
	// contains filtered or unexported fields
}

type FilterLt struct {
	// contains filtered or unexported fields
}

type FilterLte struct {
	// contains filtered or unexported fields
}

type FilterNot struct {
	// contains filtered or unexported fields
}

type FilterNotContains struct {
	// contains filtered or unexported fields
}

type FilterNotContainsAny[T any] struct {
	// contains filtered or unexported fields
}

type FilterNotEq struct {
	// contains filtered or unexported fields
}

type FilterNotGlob struct {
	// contains filtered or unexported fields
}

type FilterNotIGlob struct {
	// contains filtered or unexported fields
}

type FilterNotIn[T any] struct {
	// contains filtered or unexported fields
}

type FilterOr struct {
	// contains filtered or unexported fields
}

type FilterRegex struct {
	// contains filtered or unexported fields
}

type FullTextSearchConfig struct {
	// Whether to convert each non-ASCII character in a token to its ASCII equivalent,
	// if one exists (e.g., à -> a). Defaults to `false` (i.e., no folding).
	AsciiFolding bool `json:"ascii_folding"`
	// The `b` document length normalization parameter for BM25. Defaults to `0.75`.
	B float64 `json:"b"`
	// Whether searching is case-sensitive. Defaults to `false` (i.e.
	// case-insensitive).
	CaseSensitive bool `json:"case_sensitive"`
	// The `k1` term saturation parameter for BM25. Defaults to `1.2`.
	K1 float64 `json:"k1"`
	// Describes the language of a text attribute. Defaults to `english`.
	//
	// Any of "arabic", "danish", "dutch", "english", "finnish", "french", "german",
	// "greek", "hungarian", "italian", "norwegian", "portuguese", "romanian",
	// "russian", "spanish", "swedish", "tamil", "turkish".
	Language Language `json:"language"`
	// Maximum length of a token in bytes. Tokens larger than this value during
	// tokenization will be filtered out. Has to be between `1` and `254` (inclusive).
	// Defaults to `39`.
	MaxTokenLength int64 `json:"max_token_length"`
	// Removes common words from the text based on language. Defaults to `true` (i.e.
	// remove common words).
	RemoveStopwords bool `json:"remove_stopwords"`
	// Language-specific stemming for the text. Defaults to `false` (i.e., do not
	// stem).
	Stemming bool `json:"stemming"`
	// The tokenizer to use for full-text search on an attribute. Defaults to
	// `word_v3`.
	//
	// Any of "pre_tokenized_array", "word_v0", "word_v1", "word_v2", "word_v3".
	Tokenizer Tokenizer `json:"tokenizer"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AsciiFolding    respjson.Field
		B               respjson.Field
		CaseSensitive   respjson.Field
		K1              respjson.Field
		Language        respjson.Field
		MaxTokenLength  respjson.Field
		RemoveStopwords respjson.Field
		Stemming        respjson.Field
		Tokenizer       respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type FullTextSearchConfigParam struct {
	// Whether to convert each non-ASCII character in a token to its ASCII equivalent,
	// if one exists (e.g., à -> a). Defaults to `false` (i.e., no folding).
	AsciiFolding param.Opt[bool] `json:"ascii_folding,omitzero"`
	// The `b` document length normalization parameter for BM25. Defaults to `0.75`.
	B param.Opt[float64] `json:"b,omitzero"`
	// Whether searching is case-sensitive. Defaults to `false` (i.e.
	// case-insensitive).
	CaseSensitive param.Opt[bool] `json:"case_sensitive,omitzero"`
	// The `k1` term saturation parameter for BM25. Defaults to `1.2`.
	K1 param.Opt[float64] `json:"k1,omitzero"`
	// Removes common words from the text based on language. Defaults to `true` (i.e.
	// remove common words).
	RemoveStopwords param.Opt[bool] `json:"remove_stopwords,omitzero"`
	// Language-specific stemming for the text. Defaults to `false` (i.e., do not
	// stem).
	Stemming param.Opt[bool] `json:"stemming,omitzero"`
	// Describes the language of a text attribute. Defaults to `english`.
	//
	// Any of "arabic", "danish", "dutch", "english", "finnish", "french", "german",
	// "greek", "hungarian", "italian", "norwegian", "portuguese", "romanian",
	// "russian", "spanish", "swedish", "tamil", "turkish".
	Language Language `json:"language,omitzero"`
	// Maximum length of a token in bytes. Tokens larger than this value during
	// tokenization will be filtered out. Has to be between `1` and `254` (inclusive).
	// Defaults to `39`.
	MaxTokenLength param.Opt[int64] `json:"max_token_length,omitzero"`
	// The tokenizer to use for full-text search on an attribute. Defaults to
	// `word_v3`.
	//
	// Any of "pre_tokenized_array", "word_v0", "word_v1", "word_v2", "word_v3".
	Tokenizer Tokenizer `json:"tokenizer,omitzero"`
	// contains filtered or unexported fields
}

type ID struct {
	// This field will be present if the value is a [string] instead of an object.
	String string `json:",inline"`
	// This field will be present if the value is a [int64] instead of an object.
	Int  int64 `json:",inline"`
	JSON struct {
		String respjson.Field
		Int    respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type IDParam struct {
	String param.Opt[string] `json:",omitzero,inline"`
	Int    param.Opt[int64]  `json:",omitzero,inline"`
	// contains filtered or unexported fields
}

type IncludeAttributesParam struct {
	Bool        param.Opt[bool] `json:",omitzero,inline"`
	StringArray []string        `json:",omitzero,inline"`
	// contains filtered or unexported fields
}

type Language string

type LimitParam struct {
	// Limits the total number of documents returned.
	Total int64 `json:"total" api:"required"`
	// Limits the number of documents with the same value for a set of attributes (the
	// "limit key") that can appear in the results.
	Per LimitPerParam `json:"per,omitzero"`
	// contains filtered or unexported fields
}

type LimitPerParam struct {
	// The attributes to include in the limit key.
	Attributes []string `json:"attributes,omitzero" api:"required"`
	// The maximum number of documents to return for each value of the limit key.
	Limit int64 `json:"limit" api:"required"`
	// contains filtered or unexported fields
}

type Namespace struct {
	NamespaceService
}

type NamespaceDeleteAllParams struct {
	Namespace param.Opt[string] `path:"namespace,omitzero" api:"required" json:"-"`
	// contains filtered or unexported fields
}

type NamespaceDeleteAllResponse struct {
	// The status of the request.
	Status constant.Ok `json:"status" default:"OK"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceExplainQueryParams struct {
	Namespace param.Opt[string] `path:"namespace,omitzero" api:"required" json:"-"`
	// The number of results to return.
	TopK param.Opt[int64] `json:"top_k,omitzero"`
	// Aggregations to compute over all documents in the namespace that match the
	// filters.
	AggregateBy map[string]AggregateBy `json:"aggregate_by,omitzero"`
	// The consistency level for a query.
	Consistency NamespaceExplainQueryParamsConsistency `json:"consistency,omitzero"`
	// A function used to calculate vector similarity.
	//
	// Any of "cosine_distance", "euclidean_squared".
	DistanceMetric DistanceMetric `json:"distance_metric,omitzero"`
	// List of attribute names to exclude from the response. All other attributes will
	// be included in the response.
	ExcludeAttributes []string `json:"exclude_attributes,omitzero"`
	// Exact filters for attributes to refine search results for. Think of it as a SQL
	// WHERE clause.
	Filters Filter `json:"filters,omitzero"`
	// Groups documents by the specified attributes (the "group key") before computing
	// aggregates. Aggregates are computed separately for each group.
	GroupBy []string `json:"group_by,omitzero"`
	// Whether to include attributes in the response.
	IncludeAttributes IncludeAttributesParam `json:"include_attributes,omitzero"`
	// Limits the documents returned by a query.
	Limit LimitParam `json:"limit,omitzero"`
	// How to rank the documents in the namespace.
	RankBy RankBy `json:"rank_by,omitzero"`
	// The encoding to use for vectors in the response.
	//
	// Any of "float", "base64".
	VectorEncoding VectorEncoding `json:"vector_encoding,omitzero"`
	// contains filtered or unexported fields
}

type NamespaceExplainQueryParamsConsistency struct {
	// The query's consistency level.
	//
	// Any of "strong", "eventual".
	Level NamespaceExplainQueryParamsConsistencyLevel `json:"level,omitzero"`
	// contains filtered or unexported fields
}

type NamespaceExplainQueryParamsConsistencyLevel string

type NamespaceExplainQueryResponse struct {
	// The textual representation of the query plan.
	PlanText string `json:"plan_text"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		PlanText    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceHintCacheWarmParams struct {
	Namespace param.Opt[string] `path:"namespace,omitzero" api:"required" json:"-"`
	// contains filtered or unexported fields
}

type NamespaceHintCacheWarmResponse struct {
	// The status of the request.
	Status  constant.Accepted `json:"status" default:"ACCEPTED"`
	Message string            `json:"message"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Status      respjson.Field
		Message     respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceMetadata struct {
	// The approximate number of logical bytes in the namespace.
	ApproxLogicalBytes int64 `json:"approx_logical_bytes" api:"required"`
	// The approximate number of rows in the namespace.
	ApproxRowCount int64 `json:"approx_row_count" api:"required"`
	// The timestamp when the namespace was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Indicates that the namespace is encrypted with a customer-managed encryption key
	// (CMEK).
	Encryption NamespaceMetadataEncryption `json:"encryption" api:"required"`
	Index      NamespaceMetadataIndex      `json:"index" api:"required"`
	// The schema of the namespace.
	Schema map[string]AttributeSchemaConfig `json:"schema" api:"required"`
	// The timestamp when the namespace was last modified by a write operation.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// Configuration for namespace pinning, along with the current status of the pinned
	// namespace.
	Pinning NamespaceMetadataPinning `json:"pinning"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ApproxLogicalBytes respjson.Field
		ApproxRowCount     respjson.Field
		CreatedAt          respjson.Field
		Encryption         respjson.Field
		Index              respjson.Field
		Schema             respjson.Field
		UpdatedAt          respjson.Field
		Pinning            respjson.Field
		ExtraFields        map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceMetadataEncryption struct {
	// This field is from variant [NamespaceMetadataEncryptionSse].
	Sse bool `json:"sse"`
	// This field is from variant [NamespaceMetadataEncryptionCmek].
	Cmek NamespaceMetadataEncryptionCmekCmek `json:"cmek"`
	JSON struct {
		Sse  respjson.Field
		Cmek respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceMetadataEncryptionCmek struct {
	Cmek NamespaceMetadataEncryptionCmekCmek `json:"cmek" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Cmek        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceMetadataEncryptionCmekCmek struct {
	// The name of the CMEK key in use.
	KeyName string `json:"key_name" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		KeyName     respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceMetadataEncryptionSse struct {
	// Always true. Indicates that the namespace is encrypted with SSE.
	Sse bool `json:"sse" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Sse         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceMetadataIndex struct {
	Status string `json:"status"`
	// This field is from variant [NamespaceMetadataIndexIndexUpdating].
	UnindexedBytes int64 `json:"unindexed_bytes"`
	JSON           struct {
		Status         respjson.Field
		UnindexedBytes respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceMetadataIndexIndexUpToDate struct {
	Status constant.UpToDate `json:"status" default:"up-to-date"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceMetadataIndexIndexUpdating struct {
	Status constant.Updating `json:"status" default:"updating"`
	// The number of bytes in the namespace that are in the write-ahead log but have
	// not yet been indexed.
	UnindexedBytes int64 `json:"unindexed_bytes" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Status         respjson.Field
		UnindexedBytes respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceMetadataParams struct {
	Namespace param.Opt[string] `path:"namespace,omitzero" api:"required" json:"-"`
	// contains filtered or unexported fields
}

type NamespaceMetadataPatchParam struct {
	// Configuration for namespace pinning.
	//
	// - Missing field: no change to pinning configuration
	// - `null` or `false`: explicitly remove pinning
	// - `true`: enable pinning with default configuration
	// - Object: set pinning configuration
	Pinning PinningConfigParam `json:"pinning,omitzero"`
	// contains filtered or unexported fields
}

type NamespaceMetadataPinning struct {
	// Operational status for a pinned namespace.
	Status NamespaceMetadataPinningStatus `json:"status"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
	PinningConfig
}

type NamespaceMetadataPinningStatus struct {
	// The number of replicas that are warm and serving traffic.
	ReadyReplicas int64 `json:"ready_replicas" api:"required"`
	// The timestamp of the latest pinning status snapshot.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// Aggregate utilization for the pinned namespace, reported as a value between 0.0
	// and 1.0.
	Utilization float64 `json:"utilization" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ReadyReplicas respjson.Field
		UpdatedAt     respjson.Field
		Utilization   respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceMultiQueryParams struct {
	Namespace param.Opt[string] `path:"namespace,omitzero" api:"required" json:"-"`
	Queries   []QueryParam      `json:"queries,omitzero" api:"required"`
	// The consistency level for a query.
	Consistency NamespaceMultiQueryParamsConsistency `json:"consistency,omitzero"`
	// The encoding to use for vectors in the response.
	//
	// Any of "float", "base64".
	VectorEncoding VectorEncoding `json:"vector_encoding,omitzero"`
	// contains filtered or unexported fields
}

type NamespaceMultiQueryParamsConsistency struct {
	// The query's consistency level.
	//
	// Any of "strong", "eventual".
	Level NamespaceMultiQueryParamsConsistencyLevel `json:"level,omitzero"`
	// contains filtered or unexported fields
}

type NamespaceMultiQueryParamsConsistencyLevel string

type NamespaceMultiQueryResponse struct {
	// The billing information for a query.
	Billing QueryBilling `json:"billing" api:"required"`
	// The performance information for a query.
	Performance QueryPerformance                    `json:"performance" api:"required"`
	Results     []NamespaceMultiQueryResponseResult `json:"results" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Billing     respjson.Field
		Performance respjson.Field
		Results     respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceMultiQueryResponseResult struct {
	AggregationGroups []AggregationGroup `json:"aggregation_groups"`
	Aggregations      map[string]any     `json:"aggregations"`
	Rows              []Row              `json:"rows"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AggregationGroups respjson.Field
		Aggregations      respjson.Field
		Rows              respjson.Field
		ExtraFields       map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceQueryParams struct {
	Namespace param.Opt[string] `path:"namespace,omitzero" api:"required" json:"-"`
	// The number of results to return.
	TopK param.Opt[int64] `json:"top_k,omitzero"`
	// Aggregations to compute over all documents in the namespace that match the
	// filters.
	AggregateBy map[string]AggregateBy `json:"aggregate_by,omitzero"`
	// The consistency level for a query.
	Consistency NamespaceQueryParamsConsistency `json:"consistency,omitzero"`
	// A function used to calculate vector similarity.
	//
	// Any of "cosine_distance", "euclidean_squared".
	DistanceMetric DistanceMetric `json:"distance_metric,omitzero"`
	// List of attribute names to exclude from the response. All other attributes will
	// be included in the response.
	ExcludeAttributes []string `json:"exclude_attributes,omitzero"`
	// Exact filters for attributes to refine search results for. Think of it as a SQL
	// WHERE clause.
	Filters Filter `json:"filters,omitzero"`
	// Groups documents by the specified attributes (the "group key") before computing
	// aggregates. Aggregates are computed separately for each group.
	GroupBy []string `json:"group_by,omitzero"`
	// Whether to include attributes in the response.
	IncludeAttributes IncludeAttributesParam `json:"include_attributes,omitzero"`
	// Limits the documents returned by a query.
	Limit LimitParam `json:"limit,omitzero"`
	// How to rank the documents in the namespace.
	RankBy RankBy `json:"rank_by,omitzero"`
	// The encoding to use for vectors in the response.
	//
	// Any of "float", "base64".
	VectorEncoding VectorEncoding `json:"vector_encoding,omitzero"`
	// contains filtered or unexported fields
}

type NamespaceQueryParamsConsistency struct {
	// The query's consistency level.
	//
	// Any of "strong", "eventual".
	Level NamespaceQueryParamsConsistencyLevel `json:"level,omitzero"`
	// contains filtered or unexported fields
}

type NamespaceQueryParamsConsistencyLevel string

type NamespaceQueryResponse struct {
	// The billing information for a query.
	Billing QueryBilling `json:"billing" api:"required"`
	// The performance information for a query.
	Performance       QueryPerformance   `json:"performance" api:"required"`
	AggregationGroups []AggregationGroup `json:"aggregation_groups"`
	Aggregations      map[string]any     `json:"aggregations"`
	Rows              []Row              `json:"rows"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Billing           respjson.Field
		Performance       respjson.Field
		AggregationGroups respjson.Field
		Aggregations      respjson.Field
		Rows              respjson.Field
		ExtraFields       map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceRecallParams struct {
	Namespace param.Opt[string] `path:"namespace,omitzero" api:"required" json:"-"`
	// Include ground truth data (query vectors and true nearest neighbors) in the
	// response.
	IncludeGroundTruth param.Opt[bool] `json:"include_ground_truth,omitzero"`
	// The number of searches to run.
	Num param.Opt[int64] `json:"num,omitzero"`
	// Search for `top_k` nearest neighbors.
	TopK param.Opt[int64] `json:"top_k,omitzero"`
	// Filter by attributes. Same syntax as the query endpoint.
	Filters any `json:"filters,omitzero"`
	// The ranking function to evaluate recall for. If provided, `num` must be either
	// null or 1.
	RankBy any `json:"rank_by,omitzero"`
	// contains filtered or unexported fields
}

type NamespaceRecallResponse struct {
	// The average number of documents retrieved by the approximate nearest neighbor
	// searches.
	AvgAnnCount float64 `json:"avg_ann_count" api:"required"`
	// The average number of documents retrieved by the exhaustive searches.
	AvgExhaustiveCount float64 `json:"avg_exhaustive_count" api:"required"`
	// The average recall of the queries.
	AvgRecall float64 `json:"avg_recall" api:"required"`
	// Ground truth data including query vectors and true nearest neighbors. Only
	// included when include_ground_truth is true.
	GroundTruth []NamespaceRecallResponseGroundTruth `json:"ground_truth"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AvgAnnCount        respjson.Field
		AvgExhaustiveCount respjson.Field
		AvgRecall          respjson.Field
		GroundTruth        respjson.Field
		ExtraFields        map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceRecallResponseGroundTruth struct {
	// The true nearest neighbors with their distances and vectors.
	NearestNeighbors []Row `json:"nearest_neighbors" api:"required"`
	// The query vector used for this search.
	QueryVector []float64 `json:"query_vector" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		NearestNeighbors respjson.Field
		QueryVector      respjson.Field
		ExtraFields      map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceSchemaParams struct {
	Namespace param.Opt[string] `path:"namespace,omitzero" api:"required" json:"-"`
	// contains filtered or unexported fields
}

type NamespaceSchemaResponse map[string]AttributeSchemaConfig

type NamespaceService struct {
	Options []option.RequestOption
}

type NamespaceSummary struct {
	// The namespace ID.
	ID string `json:"id" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespaceUpdateMetadataParams struct {
	Namespace param.Opt[string] `path:"namespace,omitzero" api:"required" json:"-"`
	// Request to update namespace metadata configuration.
	NamespaceMetadataPatch NamespaceMetadataPatchParam
	// contains filtered or unexported fields
}

type NamespaceUpdateSchemaParams struct {
	Namespace param.Opt[string] `path:"namespace,omitzero" api:"required" json:"-"`
	// The desired schema for the namespace.
	Schema map[string]AttributeSchemaConfigParam
	// contains filtered or unexported fields
}

type NamespaceUpdateSchemaResponse map[string]AttributeSchemaConfig

type NamespaceWriteParams struct {
	Namespace param.Opt[string] `path:"namespace,omitzero" api:"required" json:"-"`
	// Allow partial completion when filter matches too many documents.
	DeleteByFilterAllowPartial param.Opt[bool] `json:"delete_by_filter_allow_partial,omitzero"`
	// Disables write throttling (HTTP 429 responses) during high-volume ingestion.
	DisableBackpressure param.Opt[bool] `json:"disable_backpressure,omitzero"`
	// Allow partial completion when filter matches too many documents.
	PatchByFilterAllowPartial param.Opt[bool] `json:"patch_by_filter_allow_partial,omitzero"`
	// If true, return the IDs of affected rows (deleted, patched, upserted) in the
	// response. For filtered and conditional writes, only IDs for writes that
	// succeeded will be included.
	ReturnAffectedIDs   param.Opt[bool]           `json:"return_affected_ids,omitzero"`
	BranchFromNamespace BranchFromNamespaceParams `json:"branch_from_namespace,omitzero"`
	CopyFromNamespace   CopyFromNamespaceParams   `json:"copy_from_namespace,omitzero"`
	// The filter specifying which documents to delete.
	DeleteByFilter Filter `json:"delete_by_filter,omitzero"`
	// A condition evaluated against the current value of each document targeted by a
	// delete write. Only documents that pass the condition are deleted.
	DeleteCondition Filter `json:"delete_condition,omitzero"`
	Deletes         []any  `json:"deletes,omitzero"`
	// A function used to calculate vector similarity.
	//
	// Any of "cosine_distance", "euclidean_squared".
	DistanceMetric DistanceMetric `json:"distance_metric,omitzero"`
	// The encryption configuration for a namespace.
	Encryption NamespaceWriteParamsEncryption `json:"encryption,omitzero"`
	// The patch and filter specifying which documents to patch.
	PatchByFilter NamespaceWriteParamsPatchByFilter `json:"patch_by_filter,omitzero"`
	// A list of documents in columnar format. Each key is a column name, mapped to an
	// array of values for that column.
	PatchColumns ColumnsParam `json:"patch_columns,omitzero"`
	// A condition evaluated against the current value of each document targeted by a
	// patch write. Only documents that pass the condition are patched.
	PatchCondition Filter     `json:"patch_condition,omitzero"`
	PatchRows      []RowParam `json:"patch_rows,omitzero"`
	// The schema of the attributes attached to the documents.
	Schema map[string]AttributeSchemaConfigParam `json:"schema,omitzero"`
	// A list of documents in columnar format. Each key is a column name, mapped to an
	// array of values for that column.
	UpsertColumns ColumnsParam `json:"upsert_columns,omitzero"`
	// A condition evaluated against the current value of each document targeted by an
	// upsert write. Only documents that pass the condition are upserted.
	UpsertCondition Filter     `json:"upsert_condition,omitzero"`
	UpsertRows      []RowParam `json:"upsert_rows,omitzero"`
	// contains filtered or unexported fields
}

type NamespaceWriteParamsEncryption struct {
	Cmek NamespaceWriteParamsEncryptionCmek `json:"cmek,omitzero"`
	// contains filtered or unexported fields
}

type NamespaceWriteParamsEncryptionCmek struct {
	// The identifier of the CMEK key to use for encryption. For GCP, the
	// fully-qualified resource name of the key. For AWS, the ARN of the key.
	KeyName string `json:"key_name" api:"required"`
	// contains filtered or unexported fields
}

type NamespaceWriteParamsPatchByFilter struct {
	// Filter by attributes. Same syntax as the query endpoint.
	Filters Filter         `json:"filters,omitzero" api:"required"`
	Patch   map[string]any `json:"patch,omitzero" api:"required"`
	// contains filtered or unexported fields
}

type NamespaceWriteResponse struct {
	// The billing information for a write request.
	Billing WriteBilling `json:"billing" api:"required"`
	// A message describing the result of the write request.
	Message string `json:"message" api:"required"`
	// The number of rows affected by the write request.
	RowsAffected int64 `json:"rows_affected" api:"required"`
	// The status of the request.
	Status constant.Ok `json:"status" default:"OK"`
	// The IDs of documents that were deleted. Only included when `return_affected_ids`
	// is true and at least one document was deleted.
	DeletedIDs []ID `json:"deleted_ids" format:"uuid"`
	// The IDs of documents that were patched. Only included when `return_affected_ids`
	// is true and at least one document was patched.
	PatchedIDs []ID `json:"patched_ids" format:"uuid"`
	// The performance information for a write request.
	Performance WritePerformance `json:"performance"`
	// The number of rows deleted by the write request.
	RowsDeleted int64 `json:"rows_deleted"`
	// The number of rows patched by the write request.
	RowsPatched int64 `json:"rows_patched"`
	// Whether more documents match the filter for partial operations.
	RowsRemaining bool `json:"rows_remaining"`
	// The number of rows upserted by the write request.
	RowsUpserted int64 `json:"rows_upserted"`
	// The IDs of documents that were upserted. Only included when
	// `return_affected_ids` is true and at least one document was upserted.
	UpsertedIDs []ID `json:"upserted_ids" format:"uuid"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Billing       respjson.Field
		Message       respjson.Field
		RowsAffected  respjson.Field
		Status        respjson.Field
		DeletedIDs    respjson.Field
		PatchedIDs    respjson.Field
		Performance   respjson.Field
		RowsDeleted   respjson.Field
		RowsPatched   respjson.Field
		RowsRemaining respjson.Field
		RowsUpserted  respjson.Field
		UpsertedIDs   respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type NamespacesParams struct {
	// Retrieve the next page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Limit the number of results per page.
	PageSize param.Opt[int64] `query:"page_size,omitzero" json:"-"`
	// Retrieve only the namespaces that match the prefix.
	Prefix param.Opt[string] `query:"prefix,omitzero" json:"-"`
	// contains filtered or unexported fields
}

type PinningConfig struct {
	// The number of read replicas to provision. Defaults to 1 if not specified.
	Replicas int64 `json:"replicas"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Replicas    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type PinningConfigParam struct {
	// The number of read replicas to provision. Defaults to 1 if not specified.
	Replicas param.Opt[int64] `json:"replicas,omitzero"`
	// contains filtered or unexported fields
}

type QueryBilling struct {
	// The number of billable logical bytes queried from the namespace.
	BillableLogicalBytesQueried int64 `json:"billable_logical_bytes_queried" api:"required"`
	// The number of billable logical bytes returned from the query.
	BillableLogicalBytesReturned int64 `json:"billable_logical_bytes_returned" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		BillableLogicalBytesQueried  respjson.Field
		BillableLogicalBytesReturned respjson.Field
		ExtraFields                  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type QueryParam struct {
	// The number of results to return.
	TopK param.Opt[int64] `json:"top_k,omitzero"`
	// Aggregations to compute over all documents in the namespace that match the
	// filters.
	AggregateBy map[string]AggregateBy `json:"aggregate_by,omitzero"`
	// A function used to calculate vector similarity.
	//
	// Any of "cosine_distance", "euclidean_squared".
	DistanceMetric DistanceMetric `json:"distance_metric,omitzero"`
	// List of attribute names to exclude from the response. All other attributes will
	// be included in the response.
	ExcludeAttributes []string `json:"exclude_attributes,omitzero"`
	// Exact filters for attributes to refine search results for. Think of it as a SQL
	// WHERE clause.
	Filters Filter `json:"filters,omitzero"`
	// Groups documents by the specified attributes (the "group key") before computing
	// aggregates. Aggregates are computed separately for each group.
	GroupBy []string `json:"group_by,omitzero"`
	// Whether to include attributes in the response.
	IncludeAttributes IncludeAttributesParam `json:"include_attributes,omitzero"`
	// Limits the documents returned by a query.
	Limit LimitParam `json:"limit,omitzero"`
	// How to rank the documents in the namespace.
	RankBy RankBy `json:"rank_by,omitzero"`
	// contains filtered or unexported fields
}

type QueryPerformance struct {
	// the approximate number of documents in the namespace.
	ApproxNamespaceSize int64 `json:"approx_namespace_size" api:"required"`
	// The ratio of cache hits to total cache lookups.
	CacheHitRatio float64 `json:"cache_hit_ratio" api:"required"`
	// A qualitative description of the cache hit ratio (`hot`, `warm`, or `cold`).
	CacheTemperature string `json:"cache_temperature" api:"required"`
	// The number of unindexed documents processed by the query.
	ExhaustiveSearchCount int64 `json:"exhaustive_search_count" api:"required"`
	// Request time measured on the server, excluding time spent waiting due to the
	// namespace concurrency limit.
	QueryExecutionMs int64 `json:"query_execution_ms" api:"required"`
	// Request time measured on the server, including time spent waiting for other
	// queries to complete if the namespace was at its concurrency limit.
	ServerTotalMs int64 `json:"server_total_ms" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ApproxNamespaceSize   respjson.Field
		CacheHitRatio         respjson.Field
		CacheTemperature      respjson.Field
		ExhaustiveSearchCount respjson.Field
		QueryExecutionMs      respjson.Field
		ServerTotalMs         respjson.Field
		ExtraFields           map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type RankBy interface {
	// contains filtered or unexported methods
}

type RankByAttribute struct {
	// contains filtered or unexported fields
}

type RankByAttributeOrder string

type RankByAttributes []RankByAttribute

type RankByKnn struct {
	// contains filtered or unexported fields
}

type RankByText interface {
	// contains filtered or unexported methods
}

type RankByTextAttribute struct {
	// contains filtered or unexported fields
}

type RankByTextBM25 struct {
	// contains filtered or unexported fields
}

type RankByTextBM25Array struct {
	// contains filtered or unexported fields
}

type RankByTextBM25ArrayWithParams struct {
	// contains filtered or unexported fields
}

type RankByTextBM25WithParams struct {
	// contains filtered or unexported fields
}

type RankByTextDecay struct {
	// contains filtered or unexported fields
}

type RankByTextDist struct {
	// contains filtered or unexported fields
}

type RankByTextMax struct {
	// contains filtered or unexported fields
}

type RankByTextProduct struct {
	// contains filtered or unexported fields
}

type RankByTextSaturate struct {
	// contains filtered or unexported fields
}

type RankByTextSum struct {
	// contains filtered or unexported fields
}

type RankByVector struct {
	// contains filtered or unexported fields
}

type Row map[string]any

type RowParam Row

type SaturateParams struct {
	// An exponent that helps further control the shape of the Saturate function.
	Exponent param.Opt[float64] `json:"exponent,omitzero"`
	// The midpoint of the Saturate operator.
	Midpoint any `json:"midpoint,omitzero"`
	// contains filtered or unexported fields
}

type Tokenizer string

type Vector struct {
	// This field will be present if the value is a [[]float32] instead of an object.
	FloatArray []float32 `json:",inline"`
	// This field will be present if the value is a [string] instead of an object.
	String string `json:",inline"`
	JSON   struct {
		FloatArray respjson.Field
		String     respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type VectorEncoding string

type VectorParam struct {
	FloatArray []float32         `json:",omitzero,inline"`
	String     param.Opt[string] `json:",omitzero,inline"`
	// contains filtered or unexported fields
}

type WriteBilling struct {
	// The number of billable logical bytes written to the namespace.
	BillableLogicalBytesWritten int64 `json:"billable_logical_bytes_written" api:"required"`
	// The billing information for a query.
	Query QueryBilling `json:"query"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		BillableLogicalBytesWritten respjson.Field
		Query                       respjson.Field
		ExtraFields                 map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type WritePerformance struct {
	// Request time measured on the server, in milliseconds.
	ServerTotalMs int64 `json:"server_total_ms" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ServerTotalMs respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}