Changelog¶

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased ¶

Vector search models in foxnose_sdk.flux.models:
SearchMode enum (text, vector, vector_boosted, hybrid)
VectorSearch — auto-generated embedding search configuration
VectorFieldSearch — custom pre-computed embedding search configuration
VectorBoostConfig — boost configuration for vector_boosted mode
HybridConfig — weight configuration for hybrid mode
SearchRequest — typed search payload with cross-field validation
Convenience methods on FluxClient and AsyncFluxClient:
vector_search() — semantic search with auto-generated embeddings
vector_field_search() — search with custom embedding vectors
hybrid_search() — blended text + vector search
boosted_search() — keyword search boosted by vector similarity
Vector Search documentation — dedicated guide covering all search modes
All convenience methods support offset and **extra_body pass-through for additional API parameters (where, sort, etc.)

examples/flux_client.py search example now uses correct API keys (find_text and results)

Secure Management/Flux signing with query parameters:
SecureKeyAuth now signs only the URL path (without query string)
aligns SDK signatures with server-side verification and Management auth docs
prevents 401 authentication_failed / Invalid signature on requests with query params

Flux introspection methods on sync and async clients:
get_router() calls GET /{api_prefix}/_router
get_schema(folder_path) calls GET /{api_prefix}/{folder_path}/_schema
API folder route description support in Management clients:
add_api_folder() and update_api_folder() now accept:
- description_get_one
- description_get_many
- description_search
- description_schema
APIFolderSummary model fields for route descriptions:
description_get_one
description_get_many
description_search
description_schema

upsert_resource() method on ManagementClient and AsyncManagementClient — create or update a resource by external_id in a single call. Uses PUT /folders/:folder/resources/?external_id=<value>.
batch_upsert_resources() method on ManagementClient and AsyncManagementClient — upsert multiple resources concurrently with configurable max_concurrency, fail_fast error handling mode, and optional on_progress callback.
BatchUpsertItem, BatchItemError, BatchUpsertResult models for batch upsert input/output.
external_id optional parameter on create_resource() — assign an external identifier when creating a resource via POST.
external_id field on ResourceSummary model — populated in API responses for resources that have an external identifier.

Model objects as identifiers — Management client methods now accept either string keys or corresponding model objects (e.g. FolderSummary, ResourceSummary) wherever a *_key parameter is used. This eliminates the need to manually extract .key from objects returned by the API.
_resolve_key() helper function for extracting string keys from model objects.
13 type aliases for method parameters: FolderRef, ResourceRef, RevisionRef, ComponentRef, SchemaVersionRef, OrgRef, ProjectRef, EnvironmentRef, ManagementRoleRef, FluxRoleRef, ManagementAPIKeyRef, FluxAPIKeyRef, APIRef.