objectiveai

package module
v0.0.0-...-6766ed9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 13, 2026 License: MIT Imports: 21 Imported by: 0

Documentation ¶

Overview ¶

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

Package objectiveai provides auto-generated Go types for the ObjectiveAI API.

Types are generated from JSON Schema files in objectiveai-json-schema/ by scripts/install_go.go. Do not edit generated files directly.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

THIS FILE IS AUTO-GENERATED. DO NOT EDIT. Generated by scripts/install_go.go from objectiveai-json-schema/.

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AgentCompletionsNotifyAgentCompletion ¶ 

func AgentCompletionsNotifyAgentCompletion(ctx context.Context, c *Client, params AgentCompletionsRequestAgentCompletionNotifyParams) error

func AlphaCheckBranchScalarFunction ¶ 

func AlphaCheckBranchScalarFunction(function FunctionsAlphaScalarRemoteFunction, children map[string]FunctionsFullRemoteFunction) error

AlphaCheckBranchScalarFunction validates a branch scalar function (depth > 0).

func AlphaCheckBranchVectorFunction ¶ 

func AlphaCheckBranchVectorFunction(function FunctionsAlphaVectorRemoteFunction, children map[string]FunctionsFullRemoteFunction) error

AlphaCheckBranchVectorFunction validates a branch vector function (depth > 0).

func AlphaCheckLeafScalarFunction ¶ 

func AlphaCheckLeafScalarFunction(function FunctionsAlphaScalarRemoteFunction) error

AlphaCheckLeafScalarFunction validates a leaf scalar function (depth 0).

func AlphaCheckLeafVectorFunction ¶ 

func AlphaCheckLeafVectorFunction(function FunctionsAlphaVectorRemoteFunction) error

AlphaCheckLeafVectorFunction validates a leaf vector function (depth 0).

func AuthDeleteOpenrouterByokApiKey ¶ 

func AuthDeleteOpenrouterByokApiKey(ctx context.Context, c *Client) error

func CheckScalarFields ¶ 

func CheckScalarFields(fields FunctionsCheckScalarFieldsValidation) error

CheckScalarFields validates scalar function fields.

func CheckVectorFields ¶ 

func CheckVectorFields(fields FunctionsCheckVectorFieldsValidation) error

CheckVectorFields validates vector function fields.

func CompileFunctionOutputLength ¶ 

func CompileFunctionOutputLength(function FunctionsFunction, input FunctionsExpressionInputValue) (*uint32, error)

CompileFunctionOutputLength computes the expected output length for a vector Function.

func DeleteNoContent ¶ 

func DeleteNoContent(ctx context.Context, c *Client, path string, body any) error

DeleteNoContent sends a DELETE request that expects no response body.

func DeleteUnary ¶ 

func DeleteUnary[T any](ctx context.Context, c *Client, path string, body any) (*T, error)

DeleteUnary sends a DELETE request and deserializes the JSON response into T.

func Free ¶ 

func Free(_ []byte)

Free is a no-op — all WASM memory is managed internally.

func GetUnary ¶ 

func GetUnary[T any](ctx context.Context, c *Client, path string, body any) (*T, error)

GetUnary sends a GET request and deserializes the JSON response into T.

func PostNoResponse ¶ 

func PostNoResponse(ctx context.Context, c *Client, path string, body any) error

PostNoResponse sends a POST request and discards the response body. Returns nil error on any 2xx status; otherwise returns a structured error built from the response status + body.

func PostUnary ¶ 

func PostUnary[T any](ctx context.Context, c *Client, path string, body any) (*T, error)

PostUnary sends a POST request and deserializes the JSON response into T.

func PromptId ¶ 

func PromptId(prompt []AgentCompletionsMessageMessage) (string, error)

PromptId computes a content-addressed ID for chat messages.

func RegisterOrderedMapTypes ¶ 

func RegisterOrderedMapTypes(v *validator.Validate, types ...interface{})

RegisterOrderedMapTypes registers OrderedMap instantiations with the validator so that "dive" tags work. Call once per concrete OrderedMap[K, V] type.

func ValidateFunctionInput ¶ 

func ValidateFunctionInput(function FunctionsFunction, input FunctionsExpressionInputValue) (*bool, error)

ValidateFunctionInput validates function input against its schema. Returns true if valid, false if invalid, nil if not applicable (inline function).

func VectorResponseId ¶ 

func VectorResponseId(response AgentCompletionsMessageRichContent) (string, error)

VectorResponseId computes a content-addressed ID for a vector completion response option.

Types ¶

type AgentAgent ¶ 

type AgentAgent struct {
	Remote *AgentRemoteAgent
	Inline *AgentInlineAgent
}

A validated Agent, either remote (with metadata) or inline.

func ValidateAgent ¶ 

func ValidateAgent(agent AgentAgentBase) (*AgentAgent, error)

ValidateAgent validates an Agent configuration and computes its content-addressed ID.

func (AgentAgent) MarshalJSON ¶ 

func (v AgentAgent) MarshalJSON() ([]byte, error)

func (AgentAgent) SchemaTitle ¶ 

func (AgentAgent) SchemaTitle() string

func (*AgentAgent) UnmarshalJSON ¶ 

func (v *AgentAgent) UnmarshalJSON(data []byte) error

func (AgentAgent) Validate ¶ 

func (v AgentAgent) Validate() error

type AgentAgentBase ¶ 

type AgentAgentBase struct {
	Remote *AgentRemoteAgentBase
	Inline *AgentInlineAgentBase
}

An Agent base definition, either remote (with metadata) or inline.

func (AgentAgentBase) MarshalJSON ¶ 

func (v AgentAgentBase) MarshalJSON() ([]byte, error)

func (AgentAgentBase) SchemaTitle ¶ 

func (AgentAgentBase) SchemaTitle() string

func (*AgentAgentBase) UnmarshalJSON ¶ 

func (v *AgentAgentBase) UnmarshalJSON(data []byte) error

func (AgentAgentBase) Validate ¶ 

func (v AgentAgentBase) Validate() error

type AgentAgentWithFallbacks ¶ 

type AgentAgentWithFallbacks struct {
	Remote *AgentRemoteAgentWithFallbacks
	Inline *AgentInlineAgentWithFallbacks
}

A validated agent with optional fallbacks, either remote (with description) or inline.

func (AgentAgentWithFallbacks) MarshalJSON ¶ 

func (v AgentAgentWithFallbacks) MarshalJSON() ([]byte, error)

func (AgentAgentWithFallbacks) SchemaTitle ¶ 

func (AgentAgentWithFallbacks) SchemaTitle() string

func (*AgentAgentWithFallbacks) UnmarshalJSON ¶ 

func (v *AgentAgentWithFallbacks) UnmarshalJSON(data []byte) error

func (AgentAgentWithFallbacks) Validate ¶ 

func (v AgentAgentWithFallbacks) Validate() error

type AgentAgentWithFallbacksWithCount ¶ 

type AgentAgentWithFallbacksWithCount struct {
	AgentAgentWithFallbacks
	// Number of instances of this agent in the swarm. Defaults to 1.
	Count uint64 `json:"count" validate:"min=0,max=18446744073709551615" default:"1"`
}

An [`AgentWithFallbacks`] with a count (post-validation swarm agent slot).

func (AgentAgentWithFallbacksWithCount) MarshalJSON ¶ 

func (v AgentAgentWithFallbacksWithCount) MarshalJSON() ([]byte, error)

func (AgentAgentWithFallbacksWithCount) SchemaTitle ¶ 

func (AgentAgentWithFallbacksWithCount) SchemaTitle() string

func (*AgentAgentWithFallbacksWithCount) UnmarshalJSON ¶ 

func (v *AgentAgentWithFallbacksWithCount) UnmarshalJSON(data []byte) error

func (AgentAgentWithFallbacksWithCount) Validate ¶ 

func (v AgentAgentWithFallbacksWithCount) Validate() error

type AgentClaudeAgentSdkAgent ¶ 

type AgentClaudeAgentSdkAgent struct {
	// The effort level for model output.
	Effort *AgentClaudeAgentSdkEffort `json:"effort,omitempty"`
	// The deterministic content-addressed ID (22-character base62 string).
	ID string `json:"id"`
	// MCP servers the agent can connect to.
	MCPServers *[]AgentMcpServer `json:"mcp_servers,omitempty"`
	// The upstream language model identifier.
	Model string `json:"model"`
	// The output mode for vector completions. Ignored for agent completions.
	OutputMode AgentClaudeAgentSdkOutputMode `json:"output_mode"`
	// Rich content prepended to the user's prompt.
	PrefixContent *AgentCompletionsMessageRichContent `json:"prefix_content,omitempty"`
	// Rich content appended after the user's prompt.
	SuffixContent *AgentCompletionsMessageRichContent `json:"suffix_content,omitempty"`
	// System prompt for the agent.
	SystemPrompt *string `json:"system_prompt,omitempty"`
	// Whether thinking/extended thinking is enabled.
	//
	// Defaults to `true`. Set to `false` to disable.
	Thinking *bool `json:"thinking,omitempty"`
	// The upstream provider marker.
	Upstream AgentClaudeAgentSdkUpstream `json:"upstream"`
}

A validated Claude Agent SDK Agent with its computed content-addressed ID.

func (AgentClaudeAgentSdkAgent) SchemaTitle ¶ 

func (AgentClaudeAgentSdkAgent) SchemaTitle() string

func (*AgentClaudeAgentSdkAgent) UnmarshalJSON ¶ 

func (v *AgentClaudeAgentSdkAgent) UnmarshalJSON(data []byte) error

func (AgentClaudeAgentSdkAgent) Validate ¶ 

func (v AgentClaudeAgentSdkAgent) Validate() error

type AgentClaudeAgentSdkAgentBase ¶ 

type AgentClaudeAgentSdkAgentBase struct {
	// The effort level for model output.
	Effort *AgentClaudeAgentSdkEffort `json:"effort,omitempty"`
	// MCP servers the agent can connect to.
	MCPServers *[]AgentMcpServer `json:"mcp_servers,omitempty"`
	// The upstream language model identifier.
	Model string `json:"model"`
	// The output mode for vector completions. Ignored for agent completions.
	OutputMode AgentClaudeAgentSdkOutputMode `json:"output_mode"`
	// Rich content prepended to the user's prompt.
	PrefixContent *AgentCompletionsMessageRichContent `json:"prefix_content,omitempty"`
	// Rich content appended after the user's prompt.
	SuffixContent *AgentCompletionsMessageRichContent `json:"suffix_content,omitempty"`
	// System prompt for the agent.
	SystemPrompt *string `json:"system_prompt,omitempty"`
	// Whether thinking/extended thinking is enabled.
	//
	// Defaults to `true`. Set to `false` to disable.
	Thinking *bool `json:"thinking,omitempty"`
	// The upstream provider marker.
	Upstream AgentClaudeAgentSdkUpstream `json:"upstream"`
}

The base configuration for a Claude Agent SDK Agent (without computed ID).

func (AgentClaudeAgentSdkAgentBase) SchemaTitle ¶ 

func (AgentClaudeAgentSdkAgentBase) SchemaTitle() string

func (*AgentClaudeAgentSdkAgentBase) UnmarshalJSON ¶ 

func (v *AgentClaudeAgentSdkAgentBase) UnmarshalJSON(data []byte) error

func (AgentClaudeAgentSdkAgentBase) Validate ¶ 

func (v AgentClaudeAgentSdkAgentBase) Validate() error

type AgentClaudeAgentSdkContinuation ¶ 

type AgentClaudeAgentSdkContinuation struct {
	MCPSessions OrderedMap[string, string]  `json:"mcp_sessions"`
	SessionID   string                      `json:"session_id"`
	Upstream    AgentClaudeAgentSdkUpstream `json:"upstream"`
}

func (AgentClaudeAgentSdkContinuation) SchemaTitle ¶ 

func (AgentClaudeAgentSdkContinuation) SchemaTitle() string

func (*AgentClaudeAgentSdkContinuation) UnmarshalJSON ¶ 

func (v *AgentClaudeAgentSdkContinuation) UnmarshalJSON(data []byte) error

func (AgentClaudeAgentSdkContinuation) Validate ¶ 

func (v AgentClaudeAgentSdkContinuation) Validate() error

type AgentClaudeAgentSdkEffort ¶ 

type AgentClaudeAgentSdkEffort struct {
	// Minimal output, concise responses.
	Low *AgentClaudeAgentSdkEffortLow `validate:"omitempty,oneof=low"`
	// Balanced output (default, normalized away during preparation).
	Medium *AgentClaudeAgentSdkEffortMedium `validate:"omitempty,oneof=medium"`
	// Detailed output with thorough explanations.
	High *AgentClaudeAgentSdkEffortHigh `validate:"omitempty,oneof=high"`
	// Maximum effort, most detailed output possible.
	Max *AgentClaudeAgentSdkEffortMax `validate:"omitempty,oneof=max"`
}

The effort level for model output.

This setting hints to the model how detailed its responses should be.

func (AgentClaudeAgentSdkEffort) MarshalJSON ¶ 

func (v AgentClaudeAgentSdkEffort) MarshalJSON() ([]byte, error)

func (AgentClaudeAgentSdkEffort) SchemaTitle ¶ 

func (AgentClaudeAgentSdkEffort) SchemaTitle() string

func (*AgentClaudeAgentSdkEffort) UnmarshalJSON ¶ 

func (v *AgentClaudeAgentSdkEffort) UnmarshalJSON(data []byte) error

func (AgentClaudeAgentSdkEffort) Validate ¶ 

func (v AgentClaudeAgentSdkEffort) Validate() error

type AgentClaudeAgentSdkEffortHigh ¶ 

type AgentClaudeAgentSdkEffortHigh string

func (AgentClaudeAgentSdkEffortHigh) SchemaVariantTitle ¶ 

func (AgentClaudeAgentSdkEffortHigh) SchemaVariantTitle() string

type AgentClaudeAgentSdkEffortLow ¶ 

type AgentClaudeAgentSdkEffortLow string

func (AgentClaudeAgentSdkEffortLow) SchemaVariantTitle ¶ 

func (AgentClaudeAgentSdkEffortLow) SchemaVariantTitle() string

type AgentClaudeAgentSdkEffortMax ¶ 

type AgentClaudeAgentSdkEffortMax string

func (AgentClaudeAgentSdkEffortMax) SchemaVariantTitle ¶ 

func (AgentClaudeAgentSdkEffortMax) SchemaVariantTitle() string

type AgentClaudeAgentSdkEffortMedium ¶ 

type AgentClaudeAgentSdkEffortMedium string

func (AgentClaudeAgentSdkEffortMedium) SchemaVariantTitle ¶ 

func (AgentClaudeAgentSdkEffortMedium) SchemaVariantTitle() string

type AgentClaudeAgentSdkOutputMode ¶ 

type AgentClaudeAgentSdkOutputMode struct {
	Instruction string `validate:"omitempty,oneof=instruction"`
}

The model is instructed via the prompt to output a specific key.

This is the default and most widely supported mode.

func (AgentClaudeAgentSdkOutputMode) MarshalJSON ¶ 

func (v AgentClaudeAgentSdkOutputMode) MarshalJSON() ([]byte, error)

func (AgentClaudeAgentSdkOutputMode) SchemaTitle ¶ 

func (AgentClaudeAgentSdkOutputMode) SchemaTitle() string

func (*AgentClaudeAgentSdkOutputMode) UnmarshalJSON ¶ 

func (v *AgentClaudeAgentSdkOutputMode) UnmarshalJSON(data []byte) error

func (AgentClaudeAgentSdkOutputMode) Validate ¶ 

func (v AgentClaudeAgentSdkOutputMode) Validate() error

type AgentClaudeAgentSdkUpstream ¶ 

type AgentClaudeAgentSdkUpstream struct {
	ClaudeAgentSdk string `validate:"omitempty,oneof=claude_agent_sdk"`
}

Claude Agent SDK upstream marker.

func (AgentClaudeAgentSdkUpstream) MarshalJSON ¶ 

func (v AgentClaudeAgentSdkUpstream) MarshalJSON() ([]byte, error)

func (AgentClaudeAgentSdkUpstream) SchemaTitle ¶ 

func (AgentClaudeAgentSdkUpstream) SchemaTitle() string

func (*AgentClaudeAgentSdkUpstream) UnmarshalJSON ¶ 

func (v *AgentClaudeAgentSdkUpstream) UnmarshalJSON(data []byte) error

func (AgentClaudeAgentSdkUpstream) Validate ¶ 

func (v AgentClaudeAgentSdkUpstream) Validate() error

type AgentCodexSdkAgent ¶ 

type AgentCodexSdkAgent struct {
	// Reasoning effort — maps to Codex's `model_reasoning_effort`.
	Effort *AgentCodexSdkEffort `json:"effort,omitempty"`
	// The deterministic content-addressed ID (22-character base62 string).
	ID string `json:"id"`
	// MCP servers the agent can connect to.
	MCPServers *[]AgentMcpServer `json:"mcp_servers,omitempty"`
	// The upstream language model identifier (e.g. `gpt-5`).
	Model string `json:"model"`
	// The output mode for vector completions. Ignored for agent completions.
	OutputMode AgentCodexSdkOutputMode `json:"output_mode"`
	// Rich content prepended to the user's prompt.
	PrefixContent *AgentCompletionsMessageRichContent `json:"prefix_content,omitempty"`
	// Rich content appended after the user's prompt.
	SuffixContent *AgentCompletionsMessageRichContent `json:"suffix_content,omitempty"`
	// The upstream provider marker.
	Upstream AgentCodexSdkUpstream `json:"upstream"`
	// Whether this agent may use the codex binary's web-search tool.
	WebSearchEnabled *bool `json:"web_search_enabled,omitempty"`
}

A validated Codex SDK Agent with its computed content-addressed ID.

func (AgentCodexSdkAgent) SchemaTitle ¶ 

func (AgentCodexSdkAgent) SchemaTitle() string

func (*AgentCodexSdkAgent) UnmarshalJSON ¶ 

func (v *AgentCodexSdkAgent) UnmarshalJSON(data []byte) error

func (AgentCodexSdkAgent) Validate ¶ 

func (v AgentCodexSdkAgent) Validate() error

type AgentCodexSdkAgentBase ¶ 

type AgentCodexSdkAgentBase struct {
	// Reasoning effort — maps to Codex's `model_reasoning_effort`.
	Effort *AgentCodexSdkEffort `json:"effort,omitempty"`
	// MCP servers the agent can connect to.
	MCPServers *[]AgentMcpServer `json:"mcp_servers,omitempty"`
	// The upstream language model identifier (e.g. `gpt-5`).
	Model string `json:"model"`
	// The output mode for vector completions. Ignored for agent completions.
	OutputMode AgentCodexSdkOutputMode `json:"output_mode"`
	// Rich content prepended to the user's prompt.
	PrefixContent *AgentCompletionsMessageRichContent `json:"prefix_content,omitempty"`
	// Rich content appended after the user's prompt.
	SuffixContent *AgentCompletionsMessageRichContent `json:"suffix_content,omitempty"`
	// The upstream provider marker.
	Upstream AgentCodexSdkUpstream `json:"upstream"`
	// Whether this agent may use the codex binary's web-search tool.
	WebSearchEnabled *bool `json:"web_search_enabled,omitempty"`
}

The base configuration for a Codex SDK Agent (without computed ID).

func (AgentCodexSdkAgentBase) SchemaTitle ¶ 

func (AgentCodexSdkAgentBase) SchemaTitle() string

func (*AgentCodexSdkAgentBase) UnmarshalJSON ¶ 

func (v *AgentCodexSdkAgentBase) UnmarshalJSON(data []byte) error

func (AgentCodexSdkAgentBase) Validate ¶ 

func (v AgentCodexSdkAgentBase) Validate() error

type AgentCodexSdkContinuation ¶ 

type AgentCodexSdkContinuation struct {
	MCPSessions OrderedMap[string, string] `json:"mcp_sessions"`
	ThreadID    string                     `json:"thread_id"`
	Upstream    AgentCodexSdkUpstream      `json:"upstream"`
}

func (AgentCodexSdkContinuation) SchemaTitle ¶ 

func (AgentCodexSdkContinuation) SchemaTitle() string

func (*AgentCodexSdkContinuation) UnmarshalJSON ¶ 

func (v *AgentCodexSdkContinuation) UnmarshalJSON(data []byte) error

func (AgentCodexSdkContinuation) Validate ¶ 

func (v AgentCodexSdkContinuation) Validate() error

type AgentCodexSdkEffort ¶ 

type AgentCodexSdkEffort struct {
	// Minimal reasoning, fastest responses.
	Minimal *AgentCodexSdkEffortMinimal `validate:"omitempty,oneof=minimal"`
	// Low reasoning effort.
	Low *AgentCodexSdkEffortLow `validate:"omitempty,oneof=low"`
	// Balanced reasoning (default, normalized away during preparation).
	Medium *AgentCodexSdkEffortMedium `validate:"omitempty,oneof=medium"`
	// High reasoning effort.
	High *AgentCodexSdkEffortHigh `validate:"omitempty,oneof=high"`
}

Reasoning-effort level for the Codex model. Maps to Codex's `model_reasoning_effort` (see `openai_codex_sdk` `ModelReasoningEffort`).

`Medium` is the default and is normalized to `None` during preparation for content-addressing stability.

func (AgentCodexSdkEffort) MarshalJSON ¶ 

func (v AgentCodexSdkEffort) MarshalJSON() ([]byte, error)

func (AgentCodexSdkEffort) SchemaTitle ¶ 

func (AgentCodexSdkEffort) SchemaTitle() string

func (*AgentCodexSdkEffort) UnmarshalJSON ¶ 

func (v *AgentCodexSdkEffort) UnmarshalJSON(data []byte) error

func (AgentCodexSdkEffort) Validate ¶ 

func (v AgentCodexSdkEffort) Validate() error

type AgentCodexSdkEffortHigh ¶ 

type AgentCodexSdkEffortHigh string

func (AgentCodexSdkEffortHigh) SchemaVariantTitle ¶ 

func (AgentCodexSdkEffortHigh) SchemaVariantTitle() string

type AgentCodexSdkEffortLow ¶ 

type AgentCodexSdkEffortLow string

func (AgentCodexSdkEffortLow) SchemaVariantTitle ¶ 

func (AgentCodexSdkEffortLow) SchemaVariantTitle() string

type AgentCodexSdkEffortMedium ¶ 

type AgentCodexSdkEffortMedium string

func (AgentCodexSdkEffortMedium) SchemaVariantTitle ¶ 

func (AgentCodexSdkEffortMedium) SchemaVariantTitle() string

type AgentCodexSdkEffortMinimal ¶ 

type AgentCodexSdkEffortMinimal string

func (AgentCodexSdkEffortMinimal) SchemaVariantTitle ¶ 

func (AgentCodexSdkEffortMinimal) SchemaVariantTitle() string

type AgentCodexSdkOutputMode ¶ 

type AgentCodexSdkOutputMode struct {
	Instruction string `validate:"omitempty,oneof=instruction"`
}

The model is instructed via the prompt to output a specific key.

This is the default and most widely supported mode.

func (AgentCodexSdkOutputMode) MarshalJSON ¶ 

func (v AgentCodexSdkOutputMode) MarshalJSON() ([]byte, error)

func (AgentCodexSdkOutputMode) SchemaTitle ¶ 

func (AgentCodexSdkOutputMode) SchemaTitle() string

func (*AgentCodexSdkOutputMode) UnmarshalJSON ¶ 

func (v *AgentCodexSdkOutputMode) UnmarshalJSON(data []byte) error

func (AgentCodexSdkOutputMode) Validate ¶ 

func (v AgentCodexSdkOutputMode) Validate() error

type AgentCodexSdkUpstream ¶ 

type AgentCodexSdkUpstream struct {
	CodexSdk string `validate:"omitempty,oneof=codex_sdk"`
}

Codex SDK upstream marker.

func (AgentCodexSdkUpstream) MarshalJSON ¶ 

func (v AgentCodexSdkUpstream) MarshalJSON() ([]byte, error)

func (AgentCodexSdkUpstream) SchemaTitle ¶ 

func (AgentCodexSdkUpstream) SchemaTitle() string

func (*AgentCodexSdkUpstream) UnmarshalJSON ¶ 

func (v *AgentCodexSdkUpstream) UnmarshalJSON(data []byte) error

func (AgentCodexSdkUpstream) Validate ¶ 

func (v AgentCodexSdkUpstream) Validate() error

type AgentCompletionsMessageAssistantMessage ¶ 

type AgentCompletionsMessageAssistantMessage struct {
	// The message content, if any.
	Content *AgentCompletionsMessageRichContent `json:"content,omitempty"`
	// Optional name for the assistant.
	Name *string `json:"name,omitempty"`
	// Reasoning content from models that support chain-of-thought.
	Reasoning *string `json:"reasoning,omitempty"`
	// Refusal message if the model declined to respond.
	Refusal *string `json:"refusal,omitempty"`
	// Tool calls made by the assistant.
	ToolCalls *[]AgentCompletionsMessageAssistantToolCall `json:"tool_calls,omitempty"`
}

An assistant message (model's previous response).

func (AgentCompletionsMessageAssistantMessage) SchemaTitle ¶ 

func (AgentCompletionsMessageAssistantMessage) SchemaTitle() string

func (AgentCompletionsMessageAssistantMessage) Validate ¶ 

func (v AgentCompletionsMessageAssistantMessage) Validate() error

type AgentCompletionsMessageAssistantMessageExpression ¶ 

type AgentCompletionsMessageAssistantMessageExpression struct {
	// The content expression.
	Content   *AgentCompletionsMessageAssistantMessageExpressionContent   `json:"content,omitempty"`
	Name      *AgentCompletionsMessageAssistantMessageExpressionName      `json:"name,omitempty"`
	Reasoning *AgentCompletionsMessageAssistantMessageExpressionReasoning `json:"reasoning,omitempty"`
	Refusal   *AgentCompletionsMessageAssistantMessageExpressionRefusal   `json:"refusal,omitempty"`
	ToolCalls *AgentCompletionsMessageAssistantMessageExpressionToolCalls `json:"tool_calls,omitempty"`
}

Expression variant of [`AssistantMessage`] for dynamic content.

func (AgentCompletionsMessageAssistantMessageExpression) SchemaTitle ¶ 

func (AgentCompletionsMessageAssistantMessageExpression) SchemaTitle() string

func (AgentCompletionsMessageAssistantMessageExpression) Validate ¶ 

func (v AgentCompletionsMessageAssistantMessageExpression) Validate() error

type AgentCompletionsMessageAssistantMessageExpressionContent ¶ 

type AgentCompletionsMessageAssistantMessageExpressionContent struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageRichContentExpression
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageAssistantMessageExpressionContent) MarshalJSON ¶ 

func (v AgentCompletionsMessageAssistantMessageExpressionContent) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageAssistantMessageExpressionContent) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantMessageExpressionContent) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantMessageExpressionContent) Validate ¶ 

func (v AgentCompletionsMessageAssistantMessageExpressionContent) Validate() error

type AgentCompletionsMessageAssistantMessageExpressionName ¶ 

type AgentCompletionsMessageAssistantMessageExpressionName struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageAssistantMessageExpressionNameValue
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageAssistantMessageExpressionName) MarshalJSON ¶ 

func (v AgentCompletionsMessageAssistantMessageExpressionName) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageAssistantMessageExpressionName) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantMessageExpressionName) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantMessageExpressionName) Validate ¶ 

func (v AgentCompletionsMessageAssistantMessageExpressionName) Validate() error

type AgentCompletionsMessageAssistantMessageExpressionNameValue ¶ 

type AgentCompletionsMessageAssistantMessageExpressionNameValue string

func (AgentCompletionsMessageAssistantMessageExpressionNameValue) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageAssistantMessageExpressionNameValue) SchemaVariantTitle() string

type AgentCompletionsMessageAssistantMessageExpressionReasoning ¶ 

type AgentCompletionsMessageAssistantMessageExpressionReasoning struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageAssistantMessageExpressionReasoningValue
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageAssistantMessageExpressionReasoning) MarshalJSON ¶ 

func (v AgentCompletionsMessageAssistantMessageExpressionReasoning) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageAssistantMessageExpressionReasoning) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantMessageExpressionReasoning) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantMessageExpressionReasoning) Validate ¶ 

func (v AgentCompletionsMessageAssistantMessageExpressionReasoning) Validate() error

type AgentCompletionsMessageAssistantMessageExpressionReasoningValue ¶ 

type AgentCompletionsMessageAssistantMessageExpressionReasoningValue string

func (AgentCompletionsMessageAssistantMessageExpressionReasoningValue) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageAssistantMessageExpressionReasoningValue) SchemaVariantTitle() string

type AgentCompletionsMessageAssistantMessageExpressionRefusal ¶ 

type AgentCompletionsMessageAssistantMessageExpressionRefusal struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageAssistantMessageExpressionRefusalValue
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageAssistantMessageExpressionRefusal) MarshalJSON ¶ 

func (v AgentCompletionsMessageAssistantMessageExpressionRefusal) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageAssistantMessageExpressionRefusal) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantMessageExpressionRefusal) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantMessageExpressionRefusal) Validate ¶ 

func (v AgentCompletionsMessageAssistantMessageExpressionRefusal) Validate() error

type AgentCompletionsMessageAssistantMessageExpressionRefusalValue ¶ 

type AgentCompletionsMessageAssistantMessageExpressionRefusalValue string

func (AgentCompletionsMessageAssistantMessageExpressionRefusalValue) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageAssistantMessageExpressionRefusalValue) SchemaVariantTitle() string

type AgentCompletionsMessageAssistantMessageExpressionToolCalls ¶ 

type AgentCompletionsMessageAssistantMessageExpressionToolCalls struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageAssistantMessageExpressionToolCallsValue
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageAssistantMessageExpressionToolCalls) MarshalJSON ¶ 

func (v AgentCompletionsMessageAssistantMessageExpressionToolCalls) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageAssistantMessageExpressionToolCalls) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantMessageExpressionToolCalls) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantMessageExpressionToolCalls) Validate ¶ 

func (v AgentCompletionsMessageAssistantMessageExpressionToolCalls) Validate() error

type AgentCompletionsMessageAssistantMessageExpressionToolCallsValue ¶ 

type AgentCompletionsMessageAssistantMessageExpressionToolCallsValue []AgentCompletionsMessageAssistantMessageExpressionToolCallsValueItem

func (AgentCompletionsMessageAssistantMessageExpressionToolCallsValue) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageAssistantMessageExpressionToolCallsValue) SchemaVariantTitle() string

type AgentCompletionsMessageAssistantMessageExpressionToolCallsValueItem ¶ 

type AgentCompletionsMessageAssistantMessageExpressionToolCallsValueItem struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageAssistantToolCallExpression
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageAssistantMessageExpressionToolCallsValueItem) MarshalJSON ¶ 

func (v AgentCompletionsMessageAssistantMessageExpressionToolCallsValueItem) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageAssistantMessageExpressionToolCallsValueItem) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantMessageExpressionToolCallsValueItem) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantMessageExpressionToolCallsValueItem) Validate ¶ 

func (v AgentCompletionsMessageAssistantMessageExpressionToolCallsValueItem) Validate() error

type AgentCompletionsMessageAssistantToolCall ¶ 

type AgentCompletionsMessageAssistantToolCall struct {
	// The function being called.
	Function AgentCompletionsMessageAssistantToolCallFunction `json:"function"`
	// The unique ID of this tool call.
	ID   string `json:"id"`
	Type string `json:"type" validate:"oneof=function"`
}

A function call with an ID and function details.

func (AgentCompletionsMessageAssistantToolCall) SchemaTitle ¶ 

func (AgentCompletionsMessageAssistantToolCall) SchemaTitle() string

func (*AgentCompletionsMessageAssistantToolCall) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantToolCall) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantToolCall) Validate ¶ 

func (v AgentCompletionsMessageAssistantToolCall) Validate() error

type AgentCompletionsMessageAssistantToolCallDelta ¶ 

type AgentCompletionsMessageAssistantToolCallDelta struct {
	// The function call details.
	Function *AgentCompletionsMessageAssistantToolCallFunctionDelta `json:"function,omitempty"`
	// The unique ID of this tool call.
	ID *string `json:"id,omitempty"`
	// The index of this tool call.
	Index uint64 `json:"index" validate:"min=0,max=18446744073709551615"`
	// The type of tool call (always "function").
	Type *AgentCompletionsMessageAssistantToolCallType `json:"type,omitempty"`
}

A tool call delta in a streaming response.

func (*AgentCompletionsMessageAssistantToolCallDelta) Push ¶ 

func (v *AgentCompletionsMessageAssistantToolCallDelta) Push(other *AgentCompletionsMessageAssistantToolCallDelta)

Push accumulates another AssistantToolCallDelta into this one.

func (AgentCompletionsMessageAssistantToolCallDelta) SchemaTitle ¶ 

func (AgentCompletionsMessageAssistantToolCallDelta) SchemaTitle() string

func (*AgentCompletionsMessageAssistantToolCallDelta) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantToolCallDelta) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantToolCallDelta) Validate ¶ 

func (v AgentCompletionsMessageAssistantToolCallDelta) Validate() error

type AgentCompletionsMessageAssistantToolCallExpression ¶ 

type AgentCompletionsMessageAssistantToolCallExpression struct {
	// The function expression.
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Function AgentCompletionsMessageAssistantToolCallExpressionFunction `json:"function"`
	// The tool call ID expression.
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	ID   AgentCompletionsMessageAssistantToolCallExpressionID `json:"id"`
	Type string                                               `json:"type" validate:"oneof=function"`
}

A function call expression.

func (AgentCompletionsMessageAssistantToolCallExpression) SchemaTitle ¶ 

func (AgentCompletionsMessageAssistantToolCallExpression) SchemaTitle() string

func (*AgentCompletionsMessageAssistantToolCallExpression) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantToolCallExpression) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantToolCallExpression) Validate ¶ 

func (v AgentCompletionsMessageAssistantToolCallExpression) Validate() error

type AgentCompletionsMessageAssistantToolCallExpressionFunction ¶ 

type AgentCompletionsMessageAssistantToolCallExpressionFunction struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageAssistantToolCallFunctionExpression
}

The function expression.

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageAssistantToolCallExpressionFunction) MarshalJSON ¶ 

func (v AgentCompletionsMessageAssistantToolCallExpressionFunction) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageAssistantToolCallExpressionFunction) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantToolCallExpressionFunction) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantToolCallExpressionFunction) Validate ¶ 

func (v AgentCompletionsMessageAssistantToolCallExpressionFunction) Validate() error

type AgentCompletionsMessageAssistantToolCallExpressionID ¶ 

type AgentCompletionsMessageAssistantToolCallExpressionID struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageAssistantToolCallExpressionIDValue
}

The tool call ID expression.

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageAssistantToolCallExpressionID) MarshalJSON ¶ 

func (v AgentCompletionsMessageAssistantToolCallExpressionID) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageAssistantToolCallExpressionID) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantToolCallExpressionID) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantToolCallExpressionID) Validate ¶ 

func (v AgentCompletionsMessageAssistantToolCallExpressionID) Validate() error

type AgentCompletionsMessageAssistantToolCallExpressionIDValue ¶ 

type AgentCompletionsMessageAssistantToolCallExpressionIDValue string

func (AgentCompletionsMessageAssistantToolCallExpressionIDValue) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageAssistantToolCallExpressionIDValue) SchemaVariantTitle() string

type AgentCompletionsMessageAssistantToolCallFunction ¶ 

type AgentCompletionsMessageAssistantToolCallFunction struct {
	// The arguments to pass to the function, as a JSON string.
	Arguments string `json:"arguments"`
	// The name of the function to call.
	Name string `json:"name"`
}

Details of a function call made by the assistant.

func (AgentCompletionsMessageAssistantToolCallFunction) SchemaTitle ¶ 

func (AgentCompletionsMessageAssistantToolCallFunction) SchemaTitle() string

func (*AgentCompletionsMessageAssistantToolCallFunction) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantToolCallFunction) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantToolCallFunction) Validate ¶ 

func (v AgentCompletionsMessageAssistantToolCallFunction) Validate() error

type AgentCompletionsMessageAssistantToolCallFunctionDelta ¶ 

type AgentCompletionsMessageAssistantToolCallFunctionDelta struct {
	// The arguments being streamed (accumulated across deltas).
	Arguments *string `json:"arguments,omitempty"`
	// The function name (only present in the first delta).
	Name *string `json:"name,omitempty"`
}

Function call details in a streaming tool call.

func (*AgentCompletionsMessageAssistantToolCallFunctionDelta) Push ¶ 

func (v *AgentCompletionsMessageAssistantToolCallFunctionDelta) Push(other *AgentCompletionsMessageAssistantToolCallFunctionDelta)

Push accumulates another AssistantToolCallFunctionDelta into this one.

func (AgentCompletionsMessageAssistantToolCallFunctionDelta) SchemaTitle ¶ 

func (AgentCompletionsMessageAssistantToolCallFunctionDelta) SchemaTitle() string

func (AgentCompletionsMessageAssistantToolCallFunctionDelta) Validate ¶ 

func (v AgentCompletionsMessageAssistantToolCallFunctionDelta) Validate() error

type AgentCompletionsMessageAssistantToolCallFunctionExpression ¶ 

type AgentCompletionsMessageAssistantToolCallFunctionExpression struct {
	// The arguments expression.
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Arguments AgentCompletionsMessageAssistantToolCallFunctionExpressionArguments `json:"arguments"`
	// The function name expression.
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Name AgentCompletionsMessageAssistantToolCallFunctionExpressionName `json:"name"`
}

Expression variant of [`AssistantToolCallFunction`] for dynamic content.

func (AgentCompletionsMessageAssistantToolCallFunctionExpression) SchemaTitle ¶ 

func (AgentCompletionsMessageAssistantToolCallFunctionExpression) SchemaTitle() string

func (*AgentCompletionsMessageAssistantToolCallFunctionExpression) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantToolCallFunctionExpression) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantToolCallFunctionExpression) Validate ¶ 

func (v AgentCompletionsMessageAssistantToolCallFunctionExpression) Validate() error

type AgentCompletionsMessageAssistantToolCallFunctionExpressionArguments ¶ 

type AgentCompletionsMessageAssistantToolCallFunctionExpressionArguments struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageAssistantToolCallFunctionExpressionArgumentsValue
}

The arguments expression.

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageAssistantToolCallFunctionExpressionArguments) MarshalJSON ¶ 

func (v AgentCompletionsMessageAssistantToolCallFunctionExpressionArguments) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageAssistantToolCallFunctionExpressionArguments) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantToolCallFunctionExpressionArguments) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantToolCallFunctionExpressionArguments) Validate ¶ 

func (v AgentCompletionsMessageAssistantToolCallFunctionExpressionArguments) Validate() error

type AgentCompletionsMessageAssistantToolCallFunctionExpressionArgumentsValue ¶ 

type AgentCompletionsMessageAssistantToolCallFunctionExpressionArgumentsValue string

func (AgentCompletionsMessageAssistantToolCallFunctionExpressionArgumentsValue) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageAssistantToolCallFunctionExpressionArgumentsValue) SchemaVariantTitle() string

type AgentCompletionsMessageAssistantToolCallFunctionExpressionName ¶ 

type AgentCompletionsMessageAssistantToolCallFunctionExpressionName struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageAssistantToolCallFunctionExpressionNameValue
}

The function name expression.

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageAssistantToolCallFunctionExpressionName) MarshalJSON ¶ 

func (v AgentCompletionsMessageAssistantToolCallFunctionExpressionName) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageAssistantToolCallFunctionExpressionName) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantToolCallFunctionExpressionName) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantToolCallFunctionExpressionName) Validate ¶ 

func (v AgentCompletionsMessageAssistantToolCallFunctionExpressionName) Validate() error

type AgentCompletionsMessageAssistantToolCallFunctionExpressionNameValue ¶ 

type AgentCompletionsMessageAssistantToolCallFunctionExpressionNameValue string

func (AgentCompletionsMessageAssistantToolCallFunctionExpressionNameValue) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageAssistantToolCallFunctionExpressionNameValue) SchemaVariantTitle() string

type AgentCompletionsMessageAssistantToolCallType ¶ 

type AgentCompletionsMessageAssistantToolCallType struct {
	Function string `validate:"omitempty,oneof=function"`
}

A function call.

func (AgentCompletionsMessageAssistantToolCallType) MarshalJSON ¶ 

func (v AgentCompletionsMessageAssistantToolCallType) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageAssistantToolCallType) SchemaTitle ¶ 

func (AgentCompletionsMessageAssistantToolCallType) SchemaTitle() string

func (*AgentCompletionsMessageAssistantToolCallType) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageAssistantToolCallType) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageAssistantToolCallType) Validate ¶ 

func (v AgentCompletionsMessageAssistantToolCallType) Validate() error

type AgentCompletionsMessageDeveloperMessage ¶ 

type AgentCompletionsMessageDeveloperMessage struct {
	// The message content.
	Content AgentCompletionsMessageSimpleContent `json:"content"`
	// Optional name for the message author.
	Name *string `json:"name,omitempty"`
}

A developer message.

func (*AgentCompletionsMessageDeveloperMessage) Push ¶ 

func (v *AgentCompletionsMessageDeveloperMessage) Push(other *AgentCompletionsMessageDeveloperMessage)

Push accumulates another DeveloperMessage into this one.

func (AgentCompletionsMessageDeveloperMessage) SchemaTitle ¶ 

func (AgentCompletionsMessageDeveloperMessage) SchemaTitle() string

func (*AgentCompletionsMessageDeveloperMessage) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageDeveloperMessage) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageDeveloperMessage) Validate ¶ 

func (v AgentCompletionsMessageDeveloperMessage) Validate() error

type AgentCompletionsMessageDeveloperMessageExpression ¶ 

type AgentCompletionsMessageDeveloperMessageExpression struct {
	// The message content expression.
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Content AgentCompletionsMessageDeveloperMessageExpressionContent `json:"content"`
	// Optional name expression.
	Name *AgentCompletionsMessageDeveloperMessageExpressionName `json:"name,omitempty"`
}

Expression variant of [`DeveloperMessage`] for dynamic content.

func (AgentCompletionsMessageDeveloperMessageExpression) SchemaTitle ¶ 

func (AgentCompletionsMessageDeveloperMessageExpression) SchemaTitle() string

func (*AgentCompletionsMessageDeveloperMessageExpression) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageDeveloperMessageExpression) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageDeveloperMessageExpression) Validate ¶ 

func (v AgentCompletionsMessageDeveloperMessageExpression) Validate() error

type AgentCompletionsMessageDeveloperMessageExpressionContent ¶ 

type AgentCompletionsMessageDeveloperMessageExpressionContent struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageSimpleContentExpression
}

The message content expression.

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageDeveloperMessageExpressionContent) MarshalJSON ¶ 

func (v AgentCompletionsMessageDeveloperMessageExpressionContent) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageDeveloperMessageExpressionContent) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageDeveloperMessageExpressionContent) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageDeveloperMessageExpressionContent) Validate ¶ 

func (v AgentCompletionsMessageDeveloperMessageExpressionContent) Validate() error

type AgentCompletionsMessageDeveloperMessageExpressionName ¶ 

type AgentCompletionsMessageDeveloperMessageExpressionName struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageDeveloperMessageExpressionNameValue
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageDeveloperMessageExpressionName) MarshalJSON ¶ 

func (v AgentCompletionsMessageDeveloperMessageExpressionName) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageDeveloperMessageExpressionName) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageDeveloperMessageExpressionName) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageDeveloperMessageExpressionName) Validate ¶ 

func (v AgentCompletionsMessageDeveloperMessageExpressionName) Validate() error

type AgentCompletionsMessageDeveloperMessageExpressionNameValue ¶ 

type AgentCompletionsMessageDeveloperMessageExpressionNameValue string

func (AgentCompletionsMessageDeveloperMessageExpressionNameValue) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageDeveloperMessageExpressionNameValue) SchemaVariantTitle() string

type AgentCompletionsMessageFile ¶ 

type AgentCompletionsMessageFile struct {
	// Base64-encoded file data.
	FileData *string `json:"file_data,omitempty"`
	// The ID of a previously uploaded file.
	FileID *string `json:"file_id,omitempty"`
	// A URL to fetch the file from.
	FileURL *string `json:"file_url,omitempty"`
	// The filename for display purposes.
	Filename *string `json:"filename,omitempty"`
}

A file attachment for multimodal input.

func (AgentCompletionsMessageFile) SchemaTitle ¶ 

func (AgentCompletionsMessageFile) SchemaTitle() string

func (AgentCompletionsMessageFile) Validate ¶ 

func (v AgentCompletionsMessageFile) Validate() error

type AgentCompletionsMessageImageUrl ¶ 

type AgentCompletionsMessageImageUrl struct {
	// The detail level for image processing.
	Detail *AgentCompletionsMessageImageUrlDetail `json:"detail,omitempty"`
	// The URL of the image (can be a data URL or HTTP URL).
	URL string `json:"url"`
}

An image URL for multimodal input.

func (AgentCompletionsMessageImageUrl) SchemaTitle ¶ 

func (AgentCompletionsMessageImageUrl) SchemaTitle() string

func (*AgentCompletionsMessageImageUrl) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageImageUrl) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageImageUrl) Validate ¶ 

func (v AgentCompletionsMessageImageUrl) Validate() error

type AgentCompletionsMessageImageUrlDetail ¶ 

type AgentCompletionsMessageImageUrlDetail struct {
	// Let the model decide the detail level.
	Auto *AgentCompletionsMessageImageUrlDetailAuto `validate:"omitempty,oneof=auto"`
	// Low detail mode (faster, less tokens).
	Low *AgentCompletionsMessageImageUrlDetailLow `validate:"omitempty,oneof=low"`
	// High detail mode (more accurate, more tokens).
	High *AgentCompletionsMessageImageUrlDetailHigh `validate:"omitempty,oneof=high"`
}

Detail level for image processing.

func (AgentCompletionsMessageImageUrlDetail) MarshalJSON ¶ 

func (v AgentCompletionsMessageImageUrlDetail) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageImageUrlDetail) SchemaTitle ¶ 

func (AgentCompletionsMessageImageUrlDetail) SchemaTitle() string

func (*AgentCompletionsMessageImageUrlDetail) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageImageUrlDetail) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageImageUrlDetail) Validate ¶ 

func (v AgentCompletionsMessageImageUrlDetail) Validate() error

type AgentCompletionsMessageImageUrlDetailAuto ¶ 

type AgentCompletionsMessageImageUrlDetailAuto string

func (AgentCompletionsMessageImageUrlDetailAuto) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageImageUrlDetailAuto) SchemaVariantTitle() string

type AgentCompletionsMessageImageUrlDetailHigh ¶ 

type AgentCompletionsMessageImageUrlDetailHigh string

func (AgentCompletionsMessageImageUrlDetailHigh) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageImageUrlDetailHigh) SchemaVariantTitle() string

type AgentCompletionsMessageImageUrlDetailLow ¶ 

type AgentCompletionsMessageImageUrlDetailLow string

func (AgentCompletionsMessageImageUrlDetailLow) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageImageUrlDetailLow) SchemaVariantTitle() string

type AgentCompletionsMessageInputAudio ¶ 

type AgentCompletionsMessageInputAudio struct {
	// Base64-encoded audio data.
	Data string `json:"data"`
	// The audio format (e.g., "wav", "mp3").
	Format string `json:"format"`
}

Audio input for multimodal messages.

func (AgentCompletionsMessageInputAudio) SchemaTitle ¶ 

func (AgentCompletionsMessageInputAudio) SchemaTitle() string

func (*AgentCompletionsMessageInputAudio) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageInputAudio) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageInputAudio) Validate ¶ 

func (v AgentCompletionsMessageInputAudio) Validate() error

type AgentCompletionsMessageMessage ¶ 

type AgentCompletionsMessageMessage struct {
	// A developer message (similar to system, but from the developer).
	Developer *AgentCompletionsMessageMessageDeveloper
	// A system message setting context or instructions.
	System *AgentCompletionsMessageMessageSystem
	// A user message from the end user.
	User *AgentCompletionsMessageMessageUser
	// An assistant message (model's previous response).
	Assistant *AgentCompletionsMessageMessageAssistant
	// A tool message containing the result of a tool call.
	Tool *AgentCompletionsMessageMessageTool
}

A message in the conversation.

func (AgentCompletionsMessageMessage) MarshalJSON ¶ 

func (v AgentCompletionsMessageMessage) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageMessage) SchemaTitle ¶ 

func (AgentCompletionsMessageMessage) SchemaTitle() string

func (*AgentCompletionsMessageMessage) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageMessage) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageMessage) Validate ¶ 

func (v AgentCompletionsMessageMessage) Validate() error

type AgentCompletionsMessageMessageAssistant ¶ 

type AgentCompletionsMessageMessageAssistant struct {
	AgentCompletionsMessageAssistantMessage
	Role string `json:"role" validate:"oneof=assistant"`
}

An assistant message (model's previous response).

func (AgentCompletionsMessageMessageAssistant) MarshalJSON ¶ 

func (v AgentCompletionsMessageMessageAssistant) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageMessageAssistant) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageMessageAssistant) SchemaVariantTitle() string

func (*AgentCompletionsMessageMessageAssistant) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageMessageAssistant) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageMessageDeveloper ¶ 

type AgentCompletionsMessageMessageDeveloper struct {
	AgentCompletionsMessageDeveloperMessage
	Role string `json:"role" validate:"oneof=developer"`
}

A developer message (similar to system, but from the developer).

func (AgentCompletionsMessageMessageDeveloper) MarshalJSON ¶ 

func (v AgentCompletionsMessageMessageDeveloper) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageMessageDeveloper) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageMessageDeveloper) SchemaVariantTitle() string

func (*AgentCompletionsMessageMessageDeveloper) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageMessageDeveloper) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageMessageExpression ¶ 

type AgentCompletionsMessageMessageExpression struct {
	Developer *AgentCompletionsMessageMessageExpressionDeveloper
	System    *AgentCompletionsMessageMessageExpressionSystem
	User      *AgentCompletionsMessageMessageExpressionUser
	Assistant *AgentCompletionsMessageMessageExpressionAssistant
	Tool      *AgentCompletionsMessageMessageExpressionTool
}

A message with expressions for dynamic content.

This is the expression variant of [`Message`] used in function definitions where message content can be computed from the function input at runtime. Supports both JMESPath and Starlark expressions.

func (AgentCompletionsMessageMessageExpression) MarshalJSON ¶ 

func (v AgentCompletionsMessageMessageExpression) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageMessageExpression) SchemaTitle ¶ 

func (AgentCompletionsMessageMessageExpression) SchemaTitle() string

func (*AgentCompletionsMessageMessageExpression) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageMessageExpression) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageMessageExpression) Validate ¶ 

func (v AgentCompletionsMessageMessageExpression) Validate() error

type AgentCompletionsMessageMessageExpressionAssistant ¶ 

type AgentCompletionsMessageMessageExpressionAssistant struct {
	AgentCompletionsMessageAssistantMessageExpression
	Role string `json:"role" validate:"oneof=assistant"`
}

func (AgentCompletionsMessageMessageExpressionAssistant) MarshalJSON ¶ 

func (v AgentCompletionsMessageMessageExpressionAssistant) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageMessageExpressionAssistant) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageMessageExpressionAssistant) SchemaVariantTitle() string

func (*AgentCompletionsMessageMessageExpressionAssistant) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageMessageExpressionAssistant) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageMessageExpressionDeveloper ¶ 

type AgentCompletionsMessageMessageExpressionDeveloper struct {
	AgentCompletionsMessageDeveloperMessageExpression
	Role string `json:"role" validate:"oneof=developer"`
}

func (AgentCompletionsMessageMessageExpressionDeveloper) MarshalJSON ¶ 

func (v AgentCompletionsMessageMessageExpressionDeveloper) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageMessageExpressionDeveloper) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageMessageExpressionDeveloper) SchemaVariantTitle() string

func (*AgentCompletionsMessageMessageExpressionDeveloper) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageMessageExpressionDeveloper) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageMessageExpressionSystem ¶ 

type AgentCompletionsMessageMessageExpressionSystem struct {
	AgentCompletionsMessageSystemMessageExpression
	Role string `json:"role" validate:"oneof=system"`
}

func (AgentCompletionsMessageMessageExpressionSystem) MarshalJSON ¶ 

func (v AgentCompletionsMessageMessageExpressionSystem) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageMessageExpressionSystem) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageMessageExpressionSystem) SchemaVariantTitle() string

func (*AgentCompletionsMessageMessageExpressionSystem) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageMessageExpressionSystem) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageMessageExpressionTool ¶ 

type AgentCompletionsMessageMessageExpressionTool struct {
	AgentCompletionsMessageToolMessageExpression
	Role string `json:"role" validate:"oneof=tool"`
}

func (AgentCompletionsMessageMessageExpressionTool) MarshalJSON ¶ 

func (v AgentCompletionsMessageMessageExpressionTool) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageMessageExpressionTool) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageMessageExpressionTool) SchemaVariantTitle() string

func (*AgentCompletionsMessageMessageExpressionTool) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageMessageExpressionTool) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageMessageExpressionUser ¶ 

type AgentCompletionsMessageMessageExpressionUser struct {
	AgentCompletionsMessageUserMessageExpression
	Role string `json:"role" validate:"oneof=user"`
}

func (AgentCompletionsMessageMessageExpressionUser) MarshalJSON ¶ 

func (v AgentCompletionsMessageMessageExpressionUser) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageMessageExpressionUser) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageMessageExpressionUser) SchemaVariantTitle() string

func (*AgentCompletionsMessageMessageExpressionUser) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageMessageExpressionUser) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageMessageSystem ¶ 

type AgentCompletionsMessageMessageSystem struct {
	AgentCompletionsMessageSystemMessage
	Role string `json:"role" validate:"oneof=system"`
}

A system message setting context or instructions.

func (AgentCompletionsMessageMessageSystem) MarshalJSON ¶ 

func (v AgentCompletionsMessageMessageSystem) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageMessageSystem) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageMessageSystem) SchemaVariantTitle() string

func (*AgentCompletionsMessageMessageSystem) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageMessageSystem) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageMessageTool ¶ 

type AgentCompletionsMessageMessageTool struct {
	AgentCompletionsMessageToolMessage
	Role string `json:"role" validate:"oneof=tool"`
}

A tool message containing the result of a tool call.

func (AgentCompletionsMessageMessageTool) MarshalJSON ¶ 

func (v AgentCompletionsMessageMessageTool) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageMessageTool) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageMessageTool) SchemaVariantTitle() string

func (*AgentCompletionsMessageMessageTool) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageMessageTool) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageMessageUser ¶ 

type AgentCompletionsMessageMessageUser struct {
	AgentCompletionsMessageUserMessage
	Role string `json:"role" validate:"oneof=user"`
}

A user message from the end user.

func (AgentCompletionsMessageMessageUser) MarshalJSON ¶ 

func (v AgentCompletionsMessageMessageUser) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageMessageUser) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageMessageUser) SchemaVariantTitle() string

func (*AgentCompletionsMessageMessageUser) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageMessageUser) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageRichContent ¶ 

type AgentCompletionsMessageRichContent struct {
	// Plain text content.
	Text *AgentCompletionsMessageRichContentText
	// Multi-part content (text, images, audio, video, files).
	Parts *AgentCompletionsMessageRichContentParts
}

Rich content for user/assistant messages (supports multimodal input).

func (AgentCompletionsMessageRichContent) MarshalJSON ¶ 

func (v AgentCompletionsMessageRichContent) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageRichContent) Push ¶ 

func (v *AgentCompletionsMessageRichContent) Push(other *AgentCompletionsMessageRichContent)

Push accumulates another RichContent into this one. Union dispatch: text+text -> concat, text+parts -> convert, parts+text -> append, parts+parts -> extend.

func (AgentCompletionsMessageRichContent) SchemaTitle ¶ 

func (AgentCompletionsMessageRichContent) SchemaTitle() string

func (*AgentCompletionsMessageRichContent) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContent) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageRichContent) Validate ¶ 

func (v AgentCompletionsMessageRichContent) Validate() error

type AgentCompletionsMessageRichContentExpression ¶ 

type AgentCompletionsMessageRichContentExpression struct {
	// Plain text content.
	Text *AgentCompletionsMessageRichContentExpressionText
	// Multi-part content expressions.
	Parts *AgentCompletionsMessageRichContentExpressionParts
}

Expression variant of [`RichContent`] for dynamic content.

func (AgentCompletionsMessageRichContentExpression) MarshalJSON ¶ 

func (v AgentCompletionsMessageRichContentExpression) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageRichContentExpression) SchemaTitle ¶ 

func (AgentCompletionsMessageRichContentExpression) SchemaTitle() string

func (*AgentCompletionsMessageRichContentExpression) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentExpression) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageRichContentExpression) Validate ¶ 

func (v AgentCompletionsMessageRichContentExpression) Validate() error

type AgentCompletionsMessageRichContentExpressionParts ¶ 

type AgentCompletionsMessageRichContentExpressionParts []AgentCompletionsMessageRichContentExpressionPartsItem

func (AgentCompletionsMessageRichContentExpressionParts) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentExpressionParts) SchemaVariantTitle() string

type AgentCompletionsMessageRichContentExpressionPartsItem ¶ 

type AgentCompletionsMessageRichContentExpressionPartsItem struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageRichContentPartExpression
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageRichContentExpressionPartsItem) MarshalJSON ¶ 

func (v AgentCompletionsMessageRichContentExpressionPartsItem) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageRichContentExpressionPartsItem) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentExpressionPartsItem) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageRichContentExpressionPartsItem) Validate ¶ 

func (v AgentCompletionsMessageRichContentExpressionPartsItem) Validate() error

type AgentCompletionsMessageRichContentExpressionText ¶ 

type AgentCompletionsMessageRichContentExpressionText string

func (AgentCompletionsMessageRichContentExpressionText) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentExpressionText) SchemaVariantTitle() string

type AgentCompletionsMessageRichContentPart ¶ 

type AgentCompletionsMessageRichContentPart struct {
	// Text content.
	Text *AgentCompletionsMessageRichContentPartText
	// An image URL.
	ImageUrl *AgentCompletionsMessageRichContentPartImageUrl
	// Audio input.
	InputAudio *AgentCompletionsMessageRichContentPartInputAudio
	// Video input.
	InputVideo *AgentCompletionsMessageRichContentPartInputVideo
	// A video URL.
	VideoUrl *AgentCompletionsMessageRichContentPartVideoUrl
	// A file.
	File *AgentCompletionsMessageRichContentPartFile
}

A part of rich content.

func (AgentCompletionsMessageRichContentPart) MarshalJSON ¶ 

func (v AgentCompletionsMessageRichContentPart) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageRichContentPart) SchemaTitle ¶ 

func (AgentCompletionsMessageRichContentPart) SchemaTitle() string

func (*AgentCompletionsMessageRichContentPart) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPart) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageRichContentPart) Validate ¶ 

func (v AgentCompletionsMessageRichContentPart) Validate() error

type AgentCompletionsMessageRichContentPartExpression ¶ 

type AgentCompletionsMessageRichContentPartExpression struct {
	Text       *AgentCompletionsMessageRichContentPartExpressionText
	ImageUrl   *AgentCompletionsMessageRichContentPartExpressionImageUrl
	InputAudio *AgentCompletionsMessageRichContentPartExpressionInputAudio
	InputVideo *AgentCompletionsMessageRichContentPartExpressionInputVideo
	VideoUrl   *AgentCompletionsMessageRichContentPartExpressionVideoUrl
	File       *AgentCompletionsMessageRichContentPartExpressionFile
}

Expression variant of [`RichContentPart`] for dynamic content.

func (AgentCompletionsMessageRichContentPartExpression) MarshalJSON ¶ 

func (v AgentCompletionsMessageRichContentPartExpression) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageRichContentPartExpression) SchemaTitle ¶ 

func (AgentCompletionsMessageRichContentPartExpression) SchemaTitle() string

func (*AgentCompletionsMessageRichContentPartExpression) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartExpression) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageRichContentPartExpression) Validate ¶ 

func (v AgentCompletionsMessageRichContentPartExpression) Validate() error

type AgentCompletionsMessageRichContentPartExpressionFile ¶ 

type AgentCompletionsMessageRichContentPartExpressionFile struct {
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	File AgentCompletionsMessageRichContentPartExpressionFileFile `json:"file"`
	Type string                                                   `json:"type" validate:"oneof=file"`
}

func (AgentCompletionsMessageRichContentPartExpressionFile) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentPartExpressionFile) SchemaVariantTitle() string

func (*AgentCompletionsMessageRichContentPartExpressionFile) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartExpressionFile) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageRichContentPartExpressionFileFile ¶ 

type AgentCompletionsMessageRichContentPartExpressionFileFile struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageFile
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageRichContentPartExpressionFileFile) MarshalJSON ¶ 

func (v AgentCompletionsMessageRichContentPartExpressionFileFile) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageRichContentPartExpressionFileFile) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartExpressionFileFile) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageRichContentPartExpressionFileFile) Validate ¶ 

func (v AgentCompletionsMessageRichContentPartExpressionFileFile) Validate() error

type AgentCompletionsMessageRichContentPartExpressionImageUrl ¶ 

type AgentCompletionsMessageRichContentPartExpressionImageUrl struct {
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	ImageURL AgentCompletionsMessageRichContentPartExpressionImageUrlImageURL `json:"image_url"`
	Type     string                                                           `json:"type" validate:"oneof=image_url"`
}

func (AgentCompletionsMessageRichContentPartExpressionImageUrl) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentPartExpressionImageUrl) SchemaVariantTitle() string

func (*AgentCompletionsMessageRichContentPartExpressionImageUrl) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartExpressionImageUrl) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageRichContentPartExpressionImageUrlImageURL ¶ 

type AgentCompletionsMessageRichContentPartExpressionImageUrlImageURL struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageImageUrl
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageRichContentPartExpressionImageUrlImageURL) MarshalJSON ¶ 

func (v AgentCompletionsMessageRichContentPartExpressionImageUrlImageURL) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageRichContentPartExpressionImageUrlImageURL) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartExpressionImageUrlImageURL) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageRichContentPartExpressionImageUrlImageURL) Validate ¶ 

func (v AgentCompletionsMessageRichContentPartExpressionImageUrlImageURL) Validate() error

type AgentCompletionsMessageRichContentPartExpressionInputAudio ¶ 

type AgentCompletionsMessageRichContentPartExpressionInputAudio struct {
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	InputAudio AgentCompletionsMessageRichContentPartExpressionInputAudioInputAudio `json:"input_audio"`
	Type       string                                                               `json:"type" validate:"oneof=input_audio"`
}

func (AgentCompletionsMessageRichContentPartExpressionInputAudio) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentPartExpressionInputAudio) SchemaVariantTitle() string

func (*AgentCompletionsMessageRichContentPartExpressionInputAudio) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartExpressionInputAudio) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageRichContentPartExpressionInputAudioInputAudio ¶ 

type AgentCompletionsMessageRichContentPartExpressionInputAudioInputAudio struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageInputAudio
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageRichContentPartExpressionInputAudioInputAudio) MarshalJSON ¶ 

func (v AgentCompletionsMessageRichContentPartExpressionInputAudioInputAudio) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageRichContentPartExpressionInputAudioInputAudio) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartExpressionInputAudioInputAudio) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageRichContentPartExpressionInputAudioInputAudio) Validate ¶ 

func (v AgentCompletionsMessageRichContentPartExpressionInputAudioInputAudio) Validate() error

type AgentCompletionsMessageRichContentPartExpressionInputVideo ¶ 

type AgentCompletionsMessageRichContentPartExpressionInputVideo struct {
	Type string `json:"type" validate:"oneof=input_video"`
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	VideoURL AgentCompletionsMessageRichContentPartExpressionInputVideoVideoURL `json:"video_url"`
}

func (AgentCompletionsMessageRichContentPartExpressionInputVideo) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentPartExpressionInputVideo) SchemaVariantTitle() string

func (*AgentCompletionsMessageRichContentPartExpressionInputVideo) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartExpressionInputVideo) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageRichContentPartExpressionInputVideoVideoURL ¶ 

type AgentCompletionsMessageRichContentPartExpressionInputVideoVideoURL struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageVideoUrl
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageRichContentPartExpressionInputVideoVideoURL) MarshalJSON ¶ 

func (v AgentCompletionsMessageRichContentPartExpressionInputVideoVideoURL) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageRichContentPartExpressionInputVideoVideoURL) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartExpressionInputVideoVideoURL) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageRichContentPartExpressionInputVideoVideoURL) Validate ¶ 

func (v AgentCompletionsMessageRichContentPartExpressionInputVideoVideoURL) Validate() error

type AgentCompletionsMessageRichContentPartExpressionText ¶ 

type AgentCompletionsMessageRichContentPartExpressionText struct {
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Text AgentCompletionsMessageRichContentPartExpressionTextText `json:"text"`
	Type string                                                   `json:"type" validate:"oneof=text"`
}

func (AgentCompletionsMessageRichContentPartExpressionText) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentPartExpressionText) SchemaVariantTitle() string

func (*AgentCompletionsMessageRichContentPartExpressionText) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartExpressionText) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageRichContentPartExpressionTextText ¶ 

type AgentCompletionsMessageRichContentPartExpressionTextText struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageRichContentPartExpressionTextTextValue
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageRichContentPartExpressionTextText) MarshalJSON ¶ 

func (v AgentCompletionsMessageRichContentPartExpressionTextText) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageRichContentPartExpressionTextText) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartExpressionTextText) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageRichContentPartExpressionTextText) Validate ¶ 

func (v AgentCompletionsMessageRichContentPartExpressionTextText) Validate() error

type AgentCompletionsMessageRichContentPartExpressionTextTextValue ¶ 

type AgentCompletionsMessageRichContentPartExpressionTextTextValue string

func (AgentCompletionsMessageRichContentPartExpressionTextTextValue) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentPartExpressionTextTextValue) SchemaVariantTitle() string

type AgentCompletionsMessageRichContentPartExpressionVideoUrl ¶ 

type AgentCompletionsMessageRichContentPartExpressionVideoUrl struct {
	Type string `json:"type" validate:"oneof=video_url"`
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	VideoURL AgentCompletionsMessageRichContentPartExpressionVideoUrlVideoURL `json:"video_url"`
}

func (AgentCompletionsMessageRichContentPartExpressionVideoUrl) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentPartExpressionVideoUrl) SchemaVariantTitle() string

func (*AgentCompletionsMessageRichContentPartExpressionVideoUrl) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartExpressionVideoUrl) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageRichContentPartExpressionVideoUrlVideoURL ¶ 

type AgentCompletionsMessageRichContentPartExpressionVideoUrlVideoURL struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageVideoUrl
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageRichContentPartExpressionVideoUrlVideoURL) MarshalJSON ¶ 

func (v AgentCompletionsMessageRichContentPartExpressionVideoUrlVideoURL) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageRichContentPartExpressionVideoUrlVideoURL) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartExpressionVideoUrlVideoURL) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageRichContentPartExpressionVideoUrlVideoURL) Validate ¶ 

func (v AgentCompletionsMessageRichContentPartExpressionVideoUrlVideoURL) Validate() error

type AgentCompletionsMessageRichContentPartFile ¶ 

type AgentCompletionsMessageRichContentPartFile struct {
	File AgentCompletionsMessageFile `json:"file"`
	Type string                      `json:"type" validate:"oneof=file"`
}

A file.

func (AgentCompletionsMessageRichContentPartFile) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentPartFile) SchemaVariantTitle() string

func (*AgentCompletionsMessageRichContentPartFile) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartFile) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageRichContentPartImageUrl ¶ 

type AgentCompletionsMessageRichContentPartImageUrl struct {
	ImageURL AgentCompletionsMessageImageUrl `json:"image_url"`
	Type     string                          `json:"type" validate:"oneof=image_url"`
}

An image URL.

func (AgentCompletionsMessageRichContentPartImageUrl) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentPartImageUrl) SchemaVariantTitle() string

func (*AgentCompletionsMessageRichContentPartImageUrl) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartImageUrl) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageRichContentPartInputAudio ¶ 

type AgentCompletionsMessageRichContentPartInputAudio struct {
	InputAudio AgentCompletionsMessageInputAudio `json:"input_audio"`
	Type       string                            `json:"type" validate:"oneof=input_audio"`
}

Audio input.

func (AgentCompletionsMessageRichContentPartInputAudio) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentPartInputAudio) SchemaVariantTitle() string

func (*AgentCompletionsMessageRichContentPartInputAudio) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartInputAudio) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageRichContentPartInputVideo ¶ 

type AgentCompletionsMessageRichContentPartInputVideo struct {
	Type     string                          `json:"type" validate:"oneof=input_video"`
	VideoURL AgentCompletionsMessageVideoUrl `json:"video_url"`
}

Video input.

func (AgentCompletionsMessageRichContentPartInputVideo) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentPartInputVideo) SchemaVariantTitle() string

func (*AgentCompletionsMessageRichContentPartInputVideo) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartInputVideo) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageRichContentPartText ¶ 

type AgentCompletionsMessageRichContentPartText struct {
	Text string `json:"text"`
	Type string `json:"type" validate:"oneof=text"`
}

Text content.

func (AgentCompletionsMessageRichContentPartText) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentPartText) SchemaVariantTitle() string

func (*AgentCompletionsMessageRichContentPartText) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartText) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageRichContentPartVideoUrl ¶ 

type AgentCompletionsMessageRichContentPartVideoUrl struct {
	Type     string                          `json:"type" validate:"oneof=video_url"`
	VideoURL AgentCompletionsMessageVideoUrl `json:"video_url"`
}

A video URL.

func (AgentCompletionsMessageRichContentPartVideoUrl) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentPartVideoUrl) SchemaVariantTitle() string

func (*AgentCompletionsMessageRichContentPartVideoUrl) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageRichContentPartVideoUrl) UnmarshalJSON(data []byte) error

type AgentCompletionsMessageRichContentParts ¶ 

type AgentCompletionsMessageRichContentParts []AgentCompletionsMessageRichContentPart

func (AgentCompletionsMessageRichContentParts) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentParts) SchemaVariantTitle() string

type AgentCompletionsMessageRichContentText ¶ 

type AgentCompletionsMessageRichContentText string

func (AgentCompletionsMessageRichContentText) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageRichContentText) SchemaVariantTitle() string

type AgentCompletionsMessageSimpleContent ¶ 

type AgentCompletionsMessageSimpleContent struct {
	// Plain text content.
	Text *AgentCompletionsMessageSimpleContentText
	// Multi-part text content.
	Parts *AgentCompletionsMessageSimpleContentParts
}

Simple text content for system/developer messages.

func (AgentCompletionsMessageSimpleContent) MarshalJSON ¶ 

func (v AgentCompletionsMessageSimpleContent) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageSimpleContent) Push ¶ 

func (v *AgentCompletionsMessageSimpleContent) Push(other *AgentCompletionsMessageSimpleContent)

Push accumulates another SimpleContent into this one. Union dispatch: text+text -> concat, text+parts -> convert, parts+text -> append, parts+parts -> extend.

func (AgentCompletionsMessageSimpleContent) SchemaTitle ¶ 

func (AgentCompletionsMessageSimpleContent) SchemaTitle() string

func (*AgentCompletionsMessageSimpleContent) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageSimpleContent) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageSimpleContent) Validate ¶ 

func (v AgentCompletionsMessageSimpleContent) Validate() error

type AgentCompletionsMessageSimpleContentExpression ¶ 

type AgentCompletionsMessageSimpleContentExpression struct {
	// Plain text content.
	Text *AgentCompletionsMessageSimpleContentExpressionText
	// Multi-part text content expressions.
	Parts *AgentCompletionsMessageSimpleContentExpressionParts
}

Expression variant of [`SimpleContent`] for dynamic content.

func (AgentCompletionsMessageSimpleContentExpression) MarshalJSON ¶ 

func (v AgentCompletionsMessageSimpleContentExpression) MarshalJSON() ([]byte, error)

func (AgentCompletionsMessageSimpleContentExpression) SchemaTitle ¶ 

func (AgentCompletionsMessageSimpleContentExpression) SchemaTitle() string

func (*AgentCompletionsMessageSimpleContentExpression) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageSimpleContentExpression) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageSimpleContentExpression) Validate ¶ 

func (v AgentCompletionsMessageSimpleContentExpression) Validate() error

type AgentCompletionsMessageSimpleContentExpressionParts ¶ 

type AgentCompletionsMessageSimpleContentExpressionParts []AgentCompletionsMessageSimpleContentExpressionPartsItem

func (AgentCompletionsMessageSimpleContentExpressionParts) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageSimpleContentExpressionParts) SchemaVariantTitle() string

type AgentCompletionsMessageSimpleContentExpressionPartsItem ¶ 

type AgentCompletionsMessageSimpleContentExpressionPartsItem struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageSimpleContentPartExpression
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageSimpleContentExpressionPartsItem) MarshalJSON ¶ 

func (v AgentCompletionsMessageSimpleContentExpressionPartsItem) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageSimpleContentExpressionPartsItem) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageSimpleContentExpressionPartsItem) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageSimpleContentExpressionPartsItem) Validate ¶ 

func (v AgentCompletionsMessageSimpleContentExpressionPartsItem) Validate() error

type AgentCompletionsMessageSimpleContentExpressionText ¶ 

type AgentCompletionsMessageSimpleContentExpressionText string

func (AgentCompletionsMessageSimpleContentExpressionText) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageSimpleContentExpressionText) SchemaVariantTitle() string

type AgentCompletionsMessageSimpleContentPart ¶ 

type AgentCompletionsMessageSimpleContentPart struct {
	// The text content.
	Text string `json:"text"`
	Type string `json:"type" validate:"oneof=text"`
}

A text part.

func (AgentCompletionsMessageSimpleContentPart) SchemaTitle ¶ 

func (AgentCompletionsMessageSimpleContentPart) SchemaTitle() string

func (*AgentCompletionsMessageSimpleContentPart) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageSimpleContentPart) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageSimpleContentPart) Validate ¶ 

func (v AgentCompletionsMessageSimpleContentPart) Validate() error

type AgentCompletionsMessageSimpleContentPartExpression ¶ 

type AgentCompletionsMessageSimpleContentPartExpression struct {
	// The text expression.
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Text AgentCompletionsMessageSimpleContentPartExpressionText `json:"text"`
	Type string                                                 `json:"type" validate:"oneof=text"`
}

A text part expression.

func (AgentCompletionsMessageSimpleContentPartExpression) SchemaTitle ¶ 

func (AgentCompletionsMessageSimpleContentPartExpression) SchemaTitle() string

func (*AgentCompletionsMessageSimpleContentPartExpression) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageSimpleContentPartExpression) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageSimpleContentPartExpression) Validate ¶ 

func (v AgentCompletionsMessageSimpleContentPartExpression) Validate() error

type AgentCompletionsMessageSimpleContentPartExpressionText ¶ 

type AgentCompletionsMessageSimpleContentPartExpressionText struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageSimpleContentPartExpressionTextValue
}

The text expression.

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageSimpleContentPartExpressionText) MarshalJSON ¶ 

func (v AgentCompletionsMessageSimpleContentPartExpressionText) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageSimpleContentPartExpressionText) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageSimpleContentPartExpressionText) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageSimpleContentPartExpressionText) Validate ¶ 

func (v AgentCompletionsMessageSimpleContentPartExpressionText) Validate() error

type AgentCompletionsMessageSimpleContentPartExpressionTextValue ¶ 

type AgentCompletionsMessageSimpleContentPartExpressionTextValue string

func (AgentCompletionsMessageSimpleContentPartExpressionTextValue) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageSimpleContentPartExpressionTextValue) SchemaVariantTitle() string

type AgentCompletionsMessageSimpleContentParts ¶ 

type AgentCompletionsMessageSimpleContentParts []AgentCompletionsMessageSimpleContentPart

func (AgentCompletionsMessageSimpleContentParts) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageSimpleContentParts) SchemaVariantTitle() string

type AgentCompletionsMessageSimpleContentText ¶ 

type AgentCompletionsMessageSimpleContentText string

func (AgentCompletionsMessageSimpleContentText) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageSimpleContentText) SchemaVariantTitle() string

type AgentCompletionsMessageSystemMessage ¶ 

type AgentCompletionsMessageSystemMessage struct {
	// The message content.
	Content AgentCompletionsMessageSimpleContent `json:"content"`
	// Optional name for the message author.
	Name *string `json:"name,omitempty"`
}

A system message setting context or instructions.

func (*AgentCompletionsMessageSystemMessage) Push ¶ 

func (v *AgentCompletionsMessageSystemMessage) Push(other *AgentCompletionsMessageSystemMessage)

Push accumulates another SystemMessage into this one.

func (AgentCompletionsMessageSystemMessage) SchemaTitle ¶ 

func (AgentCompletionsMessageSystemMessage) SchemaTitle() string

func (*AgentCompletionsMessageSystemMessage) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageSystemMessage) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageSystemMessage) Validate ¶ 

func (v AgentCompletionsMessageSystemMessage) Validate() error

type AgentCompletionsMessageSystemMessageExpression ¶ 

type AgentCompletionsMessageSystemMessageExpression struct {
	// The message content expression.
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Content AgentCompletionsMessageSystemMessageExpressionContent `json:"content"`
	// Optional name expression.
	Name *AgentCompletionsMessageSystemMessageExpressionName `json:"name,omitempty"`
}

Expression variant of [`SystemMessage`] for dynamic content.

func (AgentCompletionsMessageSystemMessageExpression) SchemaTitle ¶ 

func (AgentCompletionsMessageSystemMessageExpression) SchemaTitle() string

func (*AgentCompletionsMessageSystemMessageExpression) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageSystemMessageExpression) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageSystemMessageExpression) Validate ¶ 

func (v AgentCompletionsMessageSystemMessageExpression) Validate() error

type AgentCompletionsMessageSystemMessageExpressionContent ¶ 

type AgentCompletionsMessageSystemMessageExpressionContent struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageSimpleContentExpression
}

The message content expression.

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageSystemMessageExpressionContent) MarshalJSON ¶ 

func (v AgentCompletionsMessageSystemMessageExpressionContent) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageSystemMessageExpressionContent) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageSystemMessageExpressionContent) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageSystemMessageExpressionContent) Validate ¶ 

func (v AgentCompletionsMessageSystemMessageExpressionContent) Validate() error

type AgentCompletionsMessageSystemMessageExpressionName ¶ 

type AgentCompletionsMessageSystemMessageExpressionName struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageSystemMessageExpressionNameValue
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageSystemMessageExpressionName) MarshalJSON ¶ 

func (v AgentCompletionsMessageSystemMessageExpressionName) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageSystemMessageExpressionName) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageSystemMessageExpressionName) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageSystemMessageExpressionName) Validate ¶ 

func (v AgentCompletionsMessageSystemMessageExpressionName) Validate() error

type AgentCompletionsMessageSystemMessageExpressionNameValue ¶ 

type AgentCompletionsMessageSystemMessageExpressionNameValue string

func (AgentCompletionsMessageSystemMessageExpressionNameValue) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageSystemMessageExpressionNameValue) SchemaVariantTitle() string

type AgentCompletionsMessageToolMessage ¶ 

type AgentCompletionsMessageToolMessage struct {
	// The content of the tool response.
	Content AgentCompletionsMessageRichContent `json:"content"`
	// The ID of the tool call this message responds to.
	ToolCallID string `json:"tool_call_id"`
}

A tool message containing the result of a tool call.

func (AgentCompletionsMessageToolMessage) SchemaTitle ¶ 

func (AgentCompletionsMessageToolMessage) SchemaTitle() string

func (*AgentCompletionsMessageToolMessage) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageToolMessage) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageToolMessage) Validate ¶ 

func (v AgentCompletionsMessageToolMessage) Validate() error

type AgentCompletionsMessageToolMessageExpression ¶ 

type AgentCompletionsMessageToolMessageExpression struct {
	// The content expression.
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Content AgentCompletionsMessageToolMessageExpressionContent `json:"content"`
	// The tool call ID expression.
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	ToolCallID AgentCompletionsMessageToolMessageExpressionToolCallID `json:"tool_call_id"`
}

Expression variant of [`ToolMessage`] for dynamic content.

func (AgentCompletionsMessageToolMessageExpression) SchemaTitle ¶ 

func (AgentCompletionsMessageToolMessageExpression) SchemaTitle() string

func (*AgentCompletionsMessageToolMessageExpression) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageToolMessageExpression) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageToolMessageExpression) Validate ¶ 

func (v AgentCompletionsMessageToolMessageExpression) Validate() error

type AgentCompletionsMessageToolMessageExpressionContent ¶ 

type AgentCompletionsMessageToolMessageExpressionContent struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageRichContentExpression
}

The content expression.

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageToolMessageExpressionContent) MarshalJSON ¶ 

func (v AgentCompletionsMessageToolMessageExpressionContent) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageToolMessageExpressionContent) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageToolMessageExpressionContent) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageToolMessageExpressionContent) Validate ¶ 

func (v AgentCompletionsMessageToolMessageExpressionContent) Validate() error

type AgentCompletionsMessageToolMessageExpressionToolCallID ¶ 

type AgentCompletionsMessageToolMessageExpressionToolCallID struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageToolMessageExpressionToolCallIDValue
}

The tool call ID expression.

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageToolMessageExpressionToolCallID) MarshalJSON ¶ 

func (v AgentCompletionsMessageToolMessageExpressionToolCallID) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageToolMessageExpressionToolCallID) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageToolMessageExpressionToolCallID) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageToolMessageExpressionToolCallID) Validate ¶ 

func (v AgentCompletionsMessageToolMessageExpressionToolCallID) Validate() error

type AgentCompletionsMessageToolMessageExpressionToolCallIDValue ¶ 

type AgentCompletionsMessageToolMessageExpressionToolCallIDValue string

func (AgentCompletionsMessageToolMessageExpressionToolCallIDValue) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageToolMessageExpressionToolCallIDValue) SchemaVariantTitle() string

type AgentCompletionsMessageUserMessage ¶ 

type AgentCompletionsMessageUserMessage struct {
	// The message content (supports text, images, audio, video, files).
	Content AgentCompletionsMessageRichContent `json:"content"`
	// Optional name for the user.
	Name *string `json:"name,omitempty"`
}

A user message from the end user.

func (*AgentCompletionsMessageUserMessage) Push ¶ 

func (v *AgentCompletionsMessageUserMessage) Push(other *AgentCompletionsMessageUserMessage)

Push accumulates another UserMessage into this one.

func (AgentCompletionsMessageUserMessage) SchemaTitle ¶ 

func (AgentCompletionsMessageUserMessage) SchemaTitle() string

func (*AgentCompletionsMessageUserMessage) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageUserMessage) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageUserMessage) Validate ¶ 

func (v AgentCompletionsMessageUserMessage) Validate() error

type AgentCompletionsMessageUserMessageExpression ¶ 

type AgentCompletionsMessageUserMessageExpression struct {
	// The message content expression.
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Content AgentCompletionsMessageUserMessageExpressionContent `json:"content"`
	// Optional name expression.
	Name *AgentCompletionsMessageUserMessageExpressionName `json:"name,omitempty"`
}

Expression variant of [`UserMessage`] for dynamic content.

func (AgentCompletionsMessageUserMessageExpression) SchemaTitle ¶ 

func (AgentCompletionsMessageUserMessageExpression) SchemaTitle() string

func (*AgentCompletionsMessageUserMessageExpression) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageUserMessageExpression) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageUserMessageExpression) Validate ¶ 

func (v AgentCompletionsMessageUserMessageExpression) Validate() error

type AgentCompletionsMessageUserMessageExpressionContent ¶ 

type AgentCompletionsMessageUserMessageExpressionContent struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageRichContentExpression
}

The message content expression.

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageUserMessageExpressionContent) MarshalJSON ¶ 

func (v AgentCompletionsMessageUserMessageExpressionContent) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageUserMessageExpressionContent) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageUserMessageExpressionContent) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageUserMessageExpressionContent) Validate ¶ 

func (v AgentCompletionsMessageUserMessageExpressionContent) Validate() error

type AgentCompletionsMessageUserMessageExpressionName ¶ 

type AgentCompletionsMessageUserMessageExpressionName struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageUserMessageExpressionNameValue
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (AgentCompletionsMessageUserMessageExpressionName) MarshalJSON ¶ 

func (v AgentCompletionsMessageUserMessageExpressionName) MarshalJSON() ([]byte, error)

func (*AgentCompletionsMessageUserMessageExpressionName) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageUserMessageExpressionName) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageUserMessageExpressionName) Validate ¶ 

func (v AgentCompletionsMessageUserMessageExpressionName) Validate() error

type AgentCompletionsMessageUserMessageExpressionNameValue ¶ 

type AgentCompletionsMessageUserMessageExpressionNameValue string

func (AgentCompletionsMessageUserMessageExpressionNameValue) SchemaVariantTitle ¶ 

func (AgentCompletionsMessageUserMessageExpressionNameValue) SchemaVariantTitle() string

type AgentCompletionsMessageVideoUrl ¶ 

type AgentCompletionsMessageVideoUrl struct {
	// The URL of the video.
	URL string `json:"url"`
}

A video URL for multimodal input.

func (AgentCompletionsMessageVideoUrl) SchemaTitle ¶ 

func (AgentCompletionsMessageVideoUrl) SchemaTitle() string

func (*AgentCompletionsMessageVideoUrl) UnmarshalJSON ¶ 

func (v *AgentCompletionsMessageVideoUrl) UnmarshalJSON(data []byte) error

func (AgentCompletionsMessageVideoUrl) Validate ¶ 

func (v AgentCompletionsMessageVideoUrl) Validate() error

type AgentCompletionsRequestAgentCompletionCreateParams ¶ 

type AgentCompletionsRequestAgentCompletionCreateParams struct {
	// The agent to use (inline Agent or stored ID).
	Agent AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional `json:"agent"`
	// Continuation from a previous completion, as a base64-encoded string.
	Continuation *string `json:"continuation,omitempty"`
	// The conversation messages.
	Messages []AgentCompletionsMessageMessage `json:"messages"`
	// Provider routing preferences.
	Provider *AgentCompletionsRequestProvider `json:"provider,omitempty"`
	// Output format constraints (text, JSON, or JSON schema).
	ResponseFormat *AgentCompletionsRequestResponseFormatParam `json:"response_format,omitempty"`
	// Random seed for deterministic generation.
	Seed *int64 `json:"seed,omitempty" validate:"omitempty,min=-9223372036854775808,max=9223372036854775807"`
	// Whether to stream the response.
	Stream *bool `json:"stream,omitempty"`
}

Parameters for creating a agent completion.

func (AgentCompletionsRequestAgentCompletionCreateParams) SchemaTitle ¶ 

func (AgentCompletionsRequestAgentCompletionCreateParams) SchemaTitle() string

func (*AgentCompletionsRequestAgentCompletionCreateParams) UnmarshalJSON ¶ 

func (v *AgentCompletionsRequestAgentCompletionCreateParams) UnmarshalJSON(data []byte) error

func (AgentCompletionsRequestAgentCompletionCreateParams) Validate ¶ 

func (v AgentCompletionsRequestAgentCompletionCreateParams) Validate() error

type AgentCompletionsRequestAgentCompletionNotifyParams ¶ 

type AgentCompletionsRequestAgentCompletionNotifyParams struct {
	// The user message content to inject (text or multi-part rich
	// content).
	Content AgentCompletionsMessageRichContent `json:"content"`
	// The `id` of the agent completion response this message is for —
	// the same value the api echoes in the streaming/unary response's
	// `id` field.
	ResponseID string `json:"response_id"`
}

Parameters for the `agent.completions.notify` endpoint. Pushes a user message at a running agent completion identified by `response_id`; the message surfaces to the model on its next natural inspection point. The endpoint has no response body — any 2xx status is the success signal.

func (AgentCompletionsRequestAgentCompletionNotifyParams) SchemaTitle ¶ 

func (AgentCompletionsRequestAgentCompletionNotifyParams) SchemaTitle() string

func (*AgentCompletionsRequestAgentCompletionNotifyParams) UnmarshalJSON ¶ 

func (v *AgentCompletionsRequestAgentCompletionNotifyParams) UnmarshalJSON(data []byte) error

func (AgentCompletionsRequestAgentCompletionNotifyParams) Validate ¶ 

func (v AgentCompletionsRequestAgentCompletionNotifyParams) Validate() error

type AgentCompletionsRequestProvider ¶ 

type AgentCompletionsRequestProvider struct {
	// Whether to allow providers to collect data.
	DataCollection *AgentCompletionsRequestProviderDataCollection `json:"data_collection,omitempty"`
	// Hard maximum latency requirement (seconds).
	MaxLatency *float64 `json:"max_latency,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Maximum price constraints.
	MaxPrice *AgentCompletionsRequestProviderMaxPrice `json:"max_price,omitempty"`
	// Hard minimum throughput requirement (tokens/second).
	MinThroughput *float64 `json:"min_throughput,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Preferred maximum latency (seconds).
	PreferredMaxLatency *float64 `json:"preferred_max_latency,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Preferred minimum throughput (tokens/second).
	PreferredMinThroughput *float64 `json:"preferred_min_throughput,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// How to sort/prioritize providers.
	Sort *AgentCompletionsRequestProviderSort `json:"sort,omitempty"`
	// Whether to use zero data retention providers only.
	Zdr *bool `json:"zdr,omitempty"`
}

Provider routing and selection preferences.

func (AgentCompletionsRequestProvider) SchemaTitle ¶ 

func (AgentCompletionsRequestProvider) SchemaTitle() string

func (AgentCompletionsRequestProvider) Validate ¶ 

func (v AgentCompletionsRequestProvider) Validate() error

type AgentCompletionsRequestProviderDataCollection ¶ 

type AgentCompletionsRequestProviderDataCollection struct {
	// Do not allow data collection.
	Deny *AgentCompletionsRequestProviderDataCollectionDeny `validate:"omitempty,oneof=deny"`
	// Allow data collection.
	Allow *AgentCompletionsRequestProviderDataCollectionAllow `validate:"omitempty,oneof=allow"`
}

Data collection policy for providers.

func (AgentCompletionsRequestProviderDataCollection) MarshalJSON ¶ 

func (v AgentCompletionsRequestProviderDataCollection) MarshalJSON() ([]byte, error)

func (AgentCompletionsRequestProviderDataCollection) SchemaTitle ¶ 

func (AgentCompletionsRequestProviderDataCollection) SchemaTitle() string

func (*AgentCompletionsRequestProviderDataCollection) UnmarshalJSON ¶ 

func (v *AgentCompletionsRequestProviderDataCollection) UnmarshalJSON(data []byte) error

func (AgentCompletionsRequestProviderDataCollection) Validate ¶ 

func (v AgentCompletionsRequestProviderDataCollection) Validate() error

type AgentCompletionsRequestProviderDataCollectionAllow ¶ 

type AgentCompletionsRequestProviderDataCollectionAllow string

func (AgentCompletionsRequestProviderDataCollectionAllow) SchemaVariantTitle ¶ 

func (AgentCompletionsRequestProviderDataCollectionAllow) SchemaVariantTitle() string

type AgentCompletionsRequestProviderDataCollectionDeny ¶ 

type AgentCompletionsRequestProviderDataCollectionDeny string

func (AgentCompletionsRequestProviderDataCollectionDeny) SchemaVariantTitle ¶ 

func (AgentCompletionsRequestProviderDataCollectionDeny) SchemaVariantTitle() string

type AgentCompletionsRequestProviderMaxPrice ¶ 

type AgentCompletionsRequestProviderMaxPrice struct {
	// Maximum price per audio second.
	Audio *float64 `json:"audio,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Maximum price per completion token.
	Completion *float64 `json:"completion,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Maximum price per image.
	Image *float64 `json:"image,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Maximum price per prompt token.
	Prompt *float64 `json:"prompt,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Maximum price per request.
	Request *float64 `json:"request,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

Maximum price constraints per token type.

func (AgentCompletionsRequestProviderMaxPrice) SchemaTitle ¶ 

func (AgentCompletionsRequestProviderMaxPrice) SchemaTitle() string

func (AgentCompletionsRequestProviderMaxPrice) Validate ¶ 

func (v AgentCompletionsRequestProviderMaxPrice) Validate() error

type AgentCompletionsRequestProviderSort ¶ 

type AgentCompletionsRequestProviderSort struct {
	// Prioritize by price (cheapest first).
	Price *AgentCompletionsRequestProviderSortPrice `validate:"omitempty,oneof=price"`
	// Prioritize by throughput (fastest first).
	Throughput *AgentCompletionsRequestProviderSortThroughput `validate:"omitempty,oneof=throughput"`
	// Prioritize by latency (lowest first).
	Latency *AgentCompletionsRequestProviderSortLatency `validate:"omitempty,oneof=latency"`
}

How to sort/prioritize providers.

func (AgentCompletionsRequestProviderSort) MarshalJSON ¶ 

func (v AgentCompletionsRequestProviderSort) MarshalJSON() ([]byte, error)

func (AgentCompletionsRequestProviderSort) SchemaTitle ¶ 

func (AgentCompletionsRequestProviderSort) SchemaTitle() string

func (*AgentCompletionsRequestProviderSort) UnmarshalJSON ¶ 

func (v *AgentCompletionsRequestProviderSort) UnmarshalJSON(data []byte) error

func (AgentCompletionsRequestProviderSort) Validate ¶ 

func (v AgentCompletionsRequestProviderSort) Validate() error

type AgentCompletionsRequestProviderSortLatency ¶ 

type AgentCompletionsRequestProviderSortLatency string

func (AgentCompletionsRequestProviderSortLatency) SchemaVariantTitle ¶ 

func (AgentCompletionsRequestProviderSortLatency) SchemaVariantTitle() string

type AgentCompletionsRequestProviderSortPrice ¶ 

type AgentCompletionsRequestProviderSortPrice string

func (AgentCompletionsRequestProviderSortPrice) SchemaVariantTitle ¶ 

func (AgentCompletionsRequestProviderSortPrice) SchemaVariantTitle() string

type AgentCompletionsRequestProviderSortThroughput ¶ 

type AgentCompletionsRequestProviderSortThroughput string

func (AgentCompletionsRequestProviderSortThroughput) SchemaVariantTitle ¶ 

func (AgentCompletionsRequestProviderSortThroughput) SchemaVariantTitle() string

type AgentCompletionsRequestResponseFormat ¶ 

type AgentCompletionsRequestResponseFormat struct {
	// Plain text response (default).
	Text *AgentCompletionsRequestResponseFormatText
	// Response must be valid JSON.
	JsonObject *AgentCompletionsRequestResponseFormatJsonObject
	// Response must conform to a JSON schema.
	JsonSchema *AgentCompletionsRequestResponseFormatJsonSchema
	// Response must conform to a grammar.
	Grammar *AgentCompletionsRequestResponseFormatGrammar
	// Response must be valid Python code.
	Python *AgentCompletionsRequestResponseFormatPython
	// The final assistant message will contain this tool call
	ToolCall *AgentCompletionsRequestResponseFormatToolCall
}

The format of the model's response.

func (AgentCompletionsRequestResponseFormat) MarshalJSON ¶ 

func (v AgentCompletionsRequestResponseFormat) MarshalJSON() ([]byte, error)

func (AgentCompletionsRequestResponseFormat) SchemaTitle ¶ 

func (AgentCompletionsRequestResponseFormat) SchemaTitle() string

func (*AgentCompletionsRequestResponseFormat) UnmarshalJSON ¶ 

func (v *AgentCompletionsRequestResponseFormat) UnmarshalJSON(data []byte) error

func (AgentCompletionsRequestResponseFormat) Validate ¶ 

func (v AgentCompletionsRequestResponseFormat) Validate() error

type AgentCompletionsRequestResponseFormatGrammar ¶ 

type AgentCompletionsRequestResponseFormatGrammar struct {
	Grammar string `json:"grammar"`
	Type    string `json:"type" validate:"oneof=grammar"`
}

Response must conform to a grammar.

func (AgentCompletionsRequestResponseFormatGrammar) SchemaVariantTitle ¶ 

func (AgentCompletionsRequestResponseFormatGrammar) SchemaVariantTitle() string

func (*AgentCompletionsRequestResponseFormatGrammar) UnmarshalJSON ¶ 

func (v *AgentCompletionsRequestResponseFormatGrammar) UnmarshalJSON(data []byte) error

type AgentCompletionsRequestResponseFormatJsonObject ¶ 

type AgentCompletionsRequestResponseFormatJsonObject struct {
	Type string `json:"type" validate:"oneof=json_object"`
}

Response must be valid JSON.

func (AgentCompletionsRequestResponseFormatJsonObject) SchemaVariantTitle ¶ 

func (AgentCompletionsRequestResponseFormatJsonObject) SchemaVariantTitle() string

func (*AgentCompletionsRequestResponseFormatJsonObject) UnmarshalJSON ¶ 

func (v *AgentCompletionsRequestResponseFormatJsonObject) UnmarshalJSON(data []byte) error

type AgentCompletionsRequestResponseFormatJsonSchema ¶ 

type AgentCompletionsRequestResponseFormatJsonSchema struct {
	// The JSON Schema definition.
	Schema OrderedMap[string, JsonValue] `json:"schema"`
	Type   string                        `json:"type" validate:"oneof=json_schema"`
}

Response must conform to a JSON schema.

func (AgentCompletionsRequestResponseFormatJsonSchema) SchemaVariantTitle ¶ 

func (AgentCompletionsRequestResponseFormatJsonSchema) SchemaVariantTitle() string

func (*AgentCompletionsRequestResponseFormatJsonSchema) UnmarshalJSON ¶ 

func (v *AgentCompletionsRequestResponseFormatJsonSchema) UnmarshalJSON(data []byte) error

type AgentCompletionsRequestResponseFormatParam ¶ 

type AgentCompletionsRequestResponseFormatParam struct {
	// A single response format applied to all agents.
	Single *AgentCompletionsRequestResponseFormat
	// Per-agent response formats, keyed by agent ID.
	PerAgent *AgentCompletionsRequestResponseFormatParamPerAgent
}

Either a single response format or a per-agent map.

func (AgentCompletionsRequestResponseFormatParam) MarshalJSON ¶ 

func (v AgentCompletionsRequestResponseFormatParam) MarshalJSON() ([]byte, error)

func (AgentCompletionsRequestResponseFormatParam) SchemaTitle ¶ 

func (AgentCompletionsRequestResponseFormatParam) SchemaTitle() string

func (*AgentCompletionsRequestResponseFormatParam) UnmarshalJSON ¶ 

func (v *AgentCompletionsRequestResponseFormatParam) UnmarshalJSON(data []byte) error

func (AgentCompletionsRequestResponseFormatParam) Validate ¶ 

func (v AgentCompletionsRequestResponseFormatParam) Validate() error

type AgentCompletionsRequestResponseFormatParamPerAgent ¶ 

type AgentCompletionsRequestResponseFormatParamPerAgent OrderedMap[string, AgentCompletionsRequestResponseFormat]

func NewAgentCompletionsRequestResponseFormatParamPerAgent ¶ 

func NewAgentCompletionsRequestResponseFormatParamPerAgent(pairs ...orderedmap.Pair[string, AgentCompletionsRequestResponseFormat]) AgentCompletionsRequestResponseFormatParamPerAgent

func (AgentCompletionsRequestResponseFormatParamPerAgent) MarshalJSON ¶ 

func (v AgentCompletionsRequestResponseFormatParamPerAgent) MarshalJSON() ([]byte, error)

func (AgentCompletionsRequestResponseFormatParamPerAgent) SchemaVariantTitle ¶ 

func (AgentCompletionsRequestResponseFormatParamPerAgent) SchemaVariantTitle() string

func (*AgentCompletionsRequestResponseFormatParamPerAgent) UnmarshalJSON ¶ 

func (v *AgentCompletionsRequestResponseFormatParamPerAgent) UnmarshalJSON(data []byte) error

type AgentCompletionsRequestResponseFormatPython ¶ 

type AgentCompletionsRequestResponseFormatPython struct {
	Type string `json:"type" validate:"oneof=python"`
}

Response must be valid Python code.

func (AgentCompletionsRequestResponseFormatPython) SchemaVariantTitle ¶ 

func (AgentCompletionsRequestResponseFormatPython) SchemaVariantTitle() string

func (*AgentCompletionsRequestResponseFormatPython) UnmarshalJSON ¶ 

func (v *AgentCompletionsRequestResponseFormatPython) UnmarshalJSON(data []byte) error

type AgentCompletionsRequestResponseFormatText ¶ 

type AgentCompletionsRequestResponseFormatText struct {
	Type string `json:"type" validate:"oneof=text"`
}

Plain text response (default).

func (AgentCompletionsRequestResponseFormatText) SchemaVariantTitle ¶ 

func (AgentCompletionsRequestResponseFormatText) SchemaVariantTitle() string

func (*AgentCompletionsRequestResponseFormatText) UnmarshalJSON ¶ 

func (v *AgentCompletionsRequestResponseFormatText) UnmarshalJSON(data []byte) error

type AgentCompletionsRequestResponseFormatToolCall ¶ 

type AgentCompletionsRequestResponseFormatToolCall struct {
	// A description of the tool.
	Description string `json:"description"`
	// The name of the tool.
	Name string `json:"name"`
	// Whether the tool MUST be called.
	Required *bool `json:"required,omitempty"`
	// The JSON Schema definition.
	Schema OrderedMap[string, JsonValue] `json:"schema"`
	Type   string                        `json:"type" validate:"oneof=tool_call"`
}

The final assistant message will contain this tool call

func (AgentCompletionsRequestResponseFormatToolCall) SchemaVariantTitle ¶ 

func (AgentCompletionsRequestResponseFormatToolCall) SchemaVariantTitle() string

func (*AgentCompletionsRequestResponseFormatToolCall) UnmarshalJSON ¶ 

func (v *AgentCompletionsRequestResponseFormatToolCall) UnmarshalJSON(data []byte) error

type AgentCompletionsResponseAssistantRole ¶ 

type AgentCompletionsResponseAssistantRole struct {
	Assistant string `validate:"omitempty,oneof=assistant"`
}

The assistant role.

func (AgentCompletionsResponseAssistantRole) MarshalJSON ¶ 

func (v AgentCompletionsResponseAssistantRole) MarshalJSON() ([]byte, error)

func (AgentCompletionsResponseAssistantRole) SchemaTitle ¶ 

func (AgentCompletionsResponseAssistantRole) SchemaTitle() string

func (*AgentCompletionsResponseAssistantRole) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseAssistantRole) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseAssistantRole) Validate ¶ 

func (v AgentCompletionsResponseAssistantRole) Validate() error

type AgentCompletionsResponseCompletionTokensDetails ¶ 

type AgentCompletionsResponseCompletionTokensDetails struct {
	// Tokens from accepted predictions (speculative decoding).
	AcceptedPredictionTokens *uint64 `json:"accepted_prediction_tokens,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// Audio output tokens.
	AudioTokens *uint64 `json:"audio_tokens,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// Tokens used for reasoning/thinking.
	ReasoningTokens *uint64 `json:"reasoning_tokens,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// Tokens from rejected predictions (speculative decoding).
	RejectedPredictionTokens *uint64 `json:"rejected_prediction_tokens,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
}

Detailed breakdown of completion token usage.

func (*AgentCompletionsResponseCompletionTokensDetails) Push ¶ 

func (v *AgentCompletionsResponseCompletionTokensDetails) Push(other *AgentCompletionsResponseCompletionTokensDetails)

Push accumulates another CompletionTokensDetails into this one.

func (AgentCompletionsResponseCompletionTokensDetails) SchemaTitle ¶ 

func (AgentCompletionsResponseCompletionTokensDetails) SchemaTitle() string

func (AgentCompletionsResponseCompletionTokensDetails) Validate ¶ 

func (v AgentCompletionsResponseCompletionTokensDetails) Validate() error

type AgentCompletionsResponseCostDetails ¶ 

type AgentCompletionsResponseCostDetails struct {
	// Cost charged by the immediate upstream (e.g., OpenRouter).
	UpstreamInferenceCost float64 `json:"upstream_inference_cost" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Cost charged by the upstream's upstream (e.g., the actual model provider).
	UpstreamUpstreamInferenceCost float64 `json:"upstream_upstream_inference_cost" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

Detailed cost breakdown.

func (*AgentCompletionsResponseCostDetails) Push ¶ 

func (v *AgentCompletionsResponseCostDetails) Push(other *AgentCompletionsResponseCostDetails)

Push accumulates another CostDetails into this one.

func (AgentCompletionsResponseCostDetails) SchemaTitle ¶ 

func (AgentCompletionsResponseCostDetails) SchemaTitle() string

func (*AgentCompletionsResponseCostDetails) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseCostDetails) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseCostDetails) Validate ¶ 

func (v AgentCompletionsResponseCostDetails) Validate() error

type AgentCompletionsResponseFinishReason ¶ 

type AgentCompletionsResponseFinishReason struct {
	// The model reached a natural stop point or stop sequence.
	Stop *AgentCompletionsResponseFinishReasonStop `validate:"omitempty,oneof=stop"`
	// The model reached the maximum token limit.
	Length *AgentCompletionsResponseFinishReasonLength `validate:"omitempty,oneof=length"`
	// The model decided to call one or more tools.
	ToolCalls *AgentCompletionsResponseFinishReasonToolCalls `validate:"omitempty,oneof=tool_calls"`
	// The response was filtered due to content policy.
	ContentFilter *AgentCompletionsResponseFinishReasonContentFilter `validate:"omitempty,oneof=content_filter"`
	// An error occurred during generation.
	Error *AgentCompletionsResponseFinishReasonError `validate:"omitempty,oneof=error"`
}

The reason the model stopped generating.

func (AgentCompletionsResponseFinishReason) MarshalJSON ¶ 

func (v AgentCompletionsResponseFinishReason) MarshalJSON() ([]byte, error)

func (AgentCompletionsResponseFinishReason) SchemaTitle ¶ 

func (AgentCompletionsResponseFinishReason) SchemaTitle() string

func (*AgentCompletionsResponseFinishReason) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseFinishReason) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseFinishReason) Validate ¶ 

func (v AgentCompletionsResponseFinishReason) Validate() error

type AgentCompletionsResponseFinishReasonContentFilter ¶ 

type AgentCompletionsResponseFinishReasonContentFilter string

func (AgentCompletionsResponseFinishReasonContentFilter) SchemaVariantTitle ¶ 

func (AgentCompletionsResponseFinishReasonContentFilter) SchemaVariantTitle() string

type AgentCompletionsResponseFinishReasonError ¶ 

type AgentCompletionsResponseFinishReasonError string

func (AgentCompletionsResponseFinishReasonError) SchemaVariantTitle ¶ 

func (AgentCompletionsResponseFinishReasonError) SchemaVariantTitle() string

type AgentCompletionsResponseFinishReasonLength ¶ 

type AgentCompletionsResponseFinishReasonLength string

func (AgentCompletionsResponseFinishReasonLength) SchemaVariantTitle ¶ 

func (AgentCompletionsResponseFinishReasonLength) SchemaVariantTitle() string

type AgentCompletionsResponseFinishReasonStop ¶ 

type AgentCompletionsResponseFinishReasonStop string

func (AgentCompletionsResponseFinishReasonStop) SchemaVariantTitle ¶ 

func (AgentCompletionsResponseFinishReasonStop) SchemaVariantTitle() string

type AgentCompletionsResponseFinishReasonToolCalls ¶ 

type AgentCompletionsResponseFinishReasonToolCalls string

func (AgentCompletionsResponseFinishReasonToolCalls) SchemaVariantTitle ¶ 

func (AgentCompletionsResponseFinishReasonToolCalls) SchemaVariantTitle() string

type AgentCompletionsResponseLogprob ¶ 

type AgentCompletionsResponseLogprob struct {
	// The raw bytes of the token.
	Bytes *[]uint32 `json:"bytes" validate:"omitempty,dive,min=0,max=255"`
	// The log probability of this token.
	Logprob float64 `json:"logprob" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// The token string.
	Token string `json:"token"`
	// The top alternative tokens and their log probabilities.
	TopLogprobs []AgentCompletionsResponseTopLogprob `json:"top_logprobs"`
}

Log probability information for a single token.

func (AgentCompletionsResponseLogprob) SchemaTitle ¶ 

func (AgentCompletionsResponseLogprob) SchemaTitle() string

func (*AgentCompletionsResponseLogprob) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseLogprob) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseLogprob) Validate ¶ 

func (v AgentCompletionsResponseLogprob) Validate() error

type AgentCompletionsResponseLogprobs ¶ 

type AgentCompletionsResponseLogprobs struct {
	// Log probabilities for content tokens.
	Content *[]AgentCompletionsResponseLogprob `json:"content"`
	// Log probabilities for refusal tokens.
	Refusal *[]AgentCompletionsResponseLogprob `json:"refusal"`
}

Log probabilities for generated tokens.

func (*AgentCompletionsResponseLogprobs) Push ¶ 

func (v *AgentCompletionsResponseLogprobs) Push(other *AgentCompletionsResponseLogprobs)

Push accumulates another Logprobs into this one.

func (AgentCompletionsResponseLogprobs) SchemaTitle ¶ 

func (AgentCompletionsResponseLogprobs) SchemaTitle() string

func (AgentCompletionsResponseLogprobs) Validate ¶ 

func (v AgentCompletionsResponseLogprobs) Validate() error

type AgentCompletionsResponsePromptTokensDetails ¶ 

type AgentCompletionsResponsePromptTokensDetails struct {
	// Audio input tokens.
	AudioTokens *uint64 `json:"audio_tokens,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// Tokens written to cache.
	CacheWriteTokens *uint64 `json:"cache_write_tokens,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// Tokens served from cache.
	CachedTokens *uint64 `json:"cached_tokens,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// Video input tokens.
	VideoTokens *uint64 `json:"video_tokens,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
}

Detailed breakdown of prompt token usage.

func (*AgentCompletionsResponsePromptTokensDetails) Push ¶ 

func (v *AgentCompletionsResponsePromptTokensDetails) Push(other *AgentCompletionsResponsePromptTokensDetails)

Push accumulates another PromptTokensDetails into this one.

func (AgentCompletionsResponsePromptTokensDetails) SchemaTitle ¶ 

func (AgentCompletionsResponsePromptTokensDetails) SchemaTitle() string

func (AgentCompletionsResponsePromptTokensDetails) Validate ¶ 

func (v AgentCompletionsResponsePromptTokensDetails) Validate() error

type AgentCompletionsResponseStreamingAgentCompletionChunk ¶ 

type AgentCompletionsResponseStreamingAgentCompletionChunk struct {
	// Continuation state for multi-turn conversations (only present in the final chunk).
	Continuation *string `json:"continuation,omitempty"`
	Created      uint64  `json:"created" validate:"min=0,max=18446744073709551615"`
	// Error details if this completion failed.
	Error    *ErrorResponseError                             `json:"error,omitempty"`
	ID       string                                          `json:"id"`
	Messages []AgentCompletionsResponseStreamingMessageChunk `json:"messages"`
	// The object type (always "agent.completion.chunk").
	Object AgentCompletionsResponseStreamingObject `json:"object"`
	// Upstream provider
	Upstream AgentUpstream `json:"upstream"`
	// Token usage (only present in the final chunk).
	Usage *AgentCompletionsResponseUsage `json:"usage,omitempty"`
}

A chunk of a streaming agent completion response.

Multiple chunks are received via Server-Sent Events and can be accumulated into a complete [`AgentCompletion`](response::unary::AgentCompletion) using the [`push`](Self::push) method.

func AgentCompletionChunkMerged ¶ 

func AgentCompletionChunkMerged(a, b AgentCompletionsResponseStreamingAgentCompletionChunk) (*AgentCompletionsResponseStreamingAgentCompletionChunk, error)

AgentCompletionChunkMerged merges two AgentCompletionChunks via push.

func AgentCompletionChunkNormalized ¶ 

func AgentCompletionChunkNormalized(chunk AgentCompletionsResponseStreamingAgentCompletionChunk) (*AgentCompletionsResponseStreamingAgentCompletionChunk, error)

AgentCompletionChunkNormalized normalizes an AgentCompletionChunk.

func GenerateAgentCompletionChunk ¶ 

func GenerateAgentCompletionChunk(hasSeed bool, seed int64) (*AgentCompletionsResponseStreamingAgentCompletionChunk, error)

GenerateAgentCompletionChunk generates a random AgentCompletionChunk from a seed.

func (*AgentCompletionsResponseStreamingAgentCompletionChunk) Push ¶ 

func (v *AgentCompletionsResponseStreamingAgentCompletionChunk) Push(other *AgentCompletionsResponseStreamingAgentCompletionChunk)

Push accumulates another AgentCompletionChunk into this one.

func (AgentCompletionsResponseStreamingAgentCompletionChunk) SchemaTitle ¶ 

func (AgentCompletionsResponseStreamingAgentCompletionChunk) SchemaTitle() string

func (*AgentCompletionsResponseStreamingAgentCompletionChunk) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseStreamingAgentCompletionChunk) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseStreamingAgentCompletionChunk) Validate ¶ 

func (v AgentCompletionsResponseStreamingAgentCompletionChunk) Validate() error

type AgentCompletionsResponseStreamingAssistantResponseChunk ¶ 

type AgentCompletionsResponseStreamingAssistantResponseChunk struct {
	Agent             string                                           `json:"agent"`
	Content           *AgentCompletionsMessageRichContent              `json:"content,omitempty"`
	Created           uint64                                           `json:"created" validate:"min=0,max=18446744073709551615"`
	FinishReason      *AgentCompletionsResponseFinishReason            `json:"finish_reason"`
	Index             uint64                                           `json:"index" validate:"min=0,max=18446744073709551615"`
	Logprobs          *AgentCompletionsResponseLogprobs                `json:"logprobs,omitempty"`
	Model             string                                           `json:"model"`
	Provider          *string                                          `json:"provider,omitempty"`
	Reasoning         *string                                          `json:"reasoning,omitempty"`
	Refusal           *string                                          `json:"refusal,omitempty"`
	Role              AgentCompletionsResponseAssistantRole            `json:"role"`
	ServiceTier       *string                                          `json:"service_tier,omitempty"`
	SystemFingerprint *string                                          `json:"system_fingerprint,omitempty"`
	ToolCalls         *[]AgentCompletionsMessageAssistantToolCallDelta `json:"tool_calls,omitempty"`
	UpstreamID        string                                           `json:"upstream_id"`
	// Upstream usage for this assistant response (set by upstream clients).
	Usage *AgentCompletionsResponseUpstreamUsage `json:"usage,omitempty"`
}

A chunk of a streaming agent completion response.

Multiple chunks are received via Server-Sent Events and can be accumulated into a complete [`AgentCompletion`](response::unary::AgentCompletion) using the [`push`](Self::push) method.

func (*AgentCompletionsResponseStreamingAssistantResponseChunk) Push ¶ 

func (v *AgentCompletionsResponseStreamingAssistantResponseChunk) Push(other *AgentCompletionsResponseStreamingAssistantResponseChunk)

Push accumulates another AssistantResponseChunk into this one.

func (AgentCompletionsResponseStreamingAssistantResponseChunk) SchemaTitle ¶ 

func (AgentCompletionsResponseStreamingAssistantResponseChunk) SchemaTitle() string

func (*AgentCompletionsResponseStreamingAssistantResponseChunk) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseStreamingAssistantResponseChunk) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseStreamingAssistantResponseChunk) Validate ¶ 

func (v AgentCompletionsResponseStreamingAssistantResponseChunk) Validate() error

type AgentCompletionsResponseStreamingMessageChunk ¶ 

type AgentCompletionsResponseStreamingMessageChunk struct {
	Assistant *AgentCompletionsResponseStreamingAssistantResponseChunk
	Tool      *AgentCompletionsResponseToolResponse
}

func (*AgentCompletionsResponseStreamingMessageChunk) Index ¶ 

func (v *AgentCompletionsResponseStreamingMessageChunk) Index() *uint64

Index returns the index from whichever variant is set.

func (AgentCompletionsResponseStreamingMessageChunk) MarshalJSON ¶ 

func (v AgentCompletionsResponseStreamingMessageChunk) MarshalJSON() ([]byte, error)

func (*AgentCompletionsResponseStreamingMessageChunk) Push ¶ 

func (v *AgentCompletionsResponseStreamingMessageChunk) Push(other *AgentCompletionsResponseStreamingMessageChunk)

Push accumulates another MessageChunk into this one. Only merges if both are assistant variants.

func (AgentCompletionsResponseStreamingMessageChunk) SchemaTitle ¶ 

func (AgentCompletionsResponseStreamingMessageChunk) SchemaTitle() string

func (*AgentCompletionsResponseStreamingMessageChunk) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseStreamingMessageChunk) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseStreamingMessageChunk) Validate ¶ 

func (v AgentCompletionsResponseStreamingMessageChunk) Validate() error

type AgentCompletionsResponseStreamingObject ¶ 

type AgentCompletionsResponseStreamingObject struct {
	AgentCompletionChunk string `validate:"omitempty,oneof=agent.completion.chunk"`
}

A agent completion chunk object.

func (AgentCompletionsResponseStreamingObject) MarshalJSON ¶ 

func (v AgentCompletionsResponseStreamingObject) MarshalJSON() ([]byte, error)

func (AgentCompletionsResponseStreamingObject) SchemaTitle ¶ 

func (AgentCompletionsResponseStreamingObject) SchemaTitle() string

func (*AgentCompletionsResponseStreamingObject) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseStreamingObject) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseStreamingObject) Validate ¶ 

func (v AgentCompletionsResponseStreamingObject) Validate() error

type AgentCompletionsResponseToolResponse ¶ 

type AgentCompletionsResponseToolResponse struct {
	// The content of the tool response.
	Content AgentCompletionsMessageRichContent `json:"content"`
	Index   uint64                             `json:"index" validate:"min=0,max=18446744073709551615"`
	Role    AgentCompletionsResponseToolRole   `json:"role"`
	// The ID of the tool call this message responds to.
	ToolCallID string `json:"tool_call_id"`
}

A tool message containing the result of a tool call.

func (AgentCompletionsResponseToolResponse) SchemaTitle ¶ 

func (AgentCompletionsResponseToolResponse) SchemaTitle() string

func (*AgentCompletionsResponseToolResponse) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseToolResponse) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseToolResponse) Validate ¶ 

func (v AgentCompletionsResponseToolResponse) Validate() error

type AgentCompletionsResponseToolRole ¶ 

type AgentCompletionsResponseToolRole struct {
	Tool string `validate:"omitempty,oneof=tool"`
}

func (AgentCompletionsResponseToolRole) MarshalJSON ¶ 

func (v AgentCompletionsResponseToolRole) MarshalJSON() ([]byte, error)

func (AgentCompletionsResponseToolRole) SchemaTitle ¶ 

func (AgentCompletionsResponseToolRole) SchemaTitle() string

func (*AgentCompletionsResponseToolRole) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseToolRole) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseToolRole) Validate ¶ 

func (v AgentCompletionsResponseToolRole) Validate() error

type AgentCompletionsResponseTopLogprob ¶ 

type AgentCompletionsResponseTopLogprob struct {
	// The raw bytes of the token.
	Bytes *[]uint32 `json:"bytes" validate:"omitempty,dive,min=0,max=255"`
	// The log probability of this token.
	Logprob *float64 `json:"logprob" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// The token string.
	Token string `json:"token"`
}

A top alternative token with its log probability.

func (AgentCompletionsResponseTopLogprob) SchemaTitle ¶ 

func (AgentCompletionsResponseTopLogprob) SchemaTitle() string

func (*AgentCompletionsResponseTopLogprob) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseTopLogprob) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseTopLogprob) Validate ¶ 

func (v AgentCompletionsResponseTopLogprob) Validate() error

type AgentCompletionsResponseUnaryAgentCompletion ¶ 

type AgentCompletionsResponseUnaryAgentCompletion struct {
	// Continuation state for multi-turn conversations.
	Continuation *string `json:"continuation"`
	Created      uint64  `json:"created" validate:"min=0,max=18446744073709551615"`
	// Error details if this completion failed.
	Error    *ErrorResponseError                    `json:"error"`
	ID       string                                 `json:"id"`
	Messages []AgentCompletionsResponseUnaryMessage `json:"messages"`
	// The object type (always "agent.completion").
	Object AgentCompletionsResponseUnaryObject `json:"object"`
	// Upstream provider
	Upstream AgentUpstream                 `json:"upstream"`
	Usage    AgentCompletionsResponseUsage `json:"usage"`
}

A complete agent completion response.

func AgentCompletionChunkToUnary ¶ 

func AgentCompletionChunkToUnary(chunk AgentCompletionsResponseStreamingAgentCompletionChunk) (*AgentCompletionsResponseUnaryAgentCompletion, error)

AgentCompletionChunkToUnary converts an accumulated chunk to a unary AgentCompletion.

func AgentCompletionsCreateAgentCompletionUnary ¶ 

func AgentCompletionsCreateAgentCompletionUnary(ctx context.Context, c *Client, params AgentCompletionsRequestAgentCompletionCreateParams) (*AgentCompletionsResponseUnaryAgentCompletion, error)

func NormalizeAgentCompletionForTests ¶ 

func NormalizeAgentCompletionForTests(v AgentCompletionsResponseUnaryAgentCompletion) (*AgentCompletionsResponseUnaryAgentCompletion, error)

NormalizeAgentCompletionForTests normalizes an AgentCompletion by round-tripping through serde.

func (AgentCompletionsResponseUnaryAgentCompletion) SchemaTitle ¶ 

func (AgentCompletionsResponseUnaryAgentCompletion) SchemaTitle() string

func (*AgentCompletionsResponseUnaryAgentCompletion) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseUnaryAgentCompletion) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseUnaryAgentCompletion) Validate ¶ 

func (v AgentCompletionsResponseUnaryAgentCompletion) Validate() error

type AgentCompletionsResponseUnaryAssistantResponse ¶ 

type AgentCompletionsResponseUnaryAssistantResponse struct {
	Agent             string                                      `json:"agent"`
	Content           *AgentCompletionsMessageRichContent         `json:"content"`
	Created           uint64                                      `json:"created" validate:"min=0,max=18446744073709551615"`
	FinishReason      AgentCompletionsResponseFinishReason        `json:"finish_reason"`
	Index             uint64                                      `json:"index" validate:"min=0,max=18446744073709551615"`
	Logprobs          *AgentCompletionsResponseLogprobs           `json:"logprobs"`
	Model             string                                      `json:"model"`
	Provider          *string                                     `json:"provider,omitempty"`
	Reasoning         *string                                     `json:"reasoning,omitempty"`
	Refusal           *string                                     `json:"refusal"`
	Role              AgentCompletionsResponseAssistantRole       `json:"role"`
	ServiceTier       *string                                     `json:"service_tier,omitempty"`
	SystemFingerprint *string                                     `json:"system_fingerprint,omitempty"`
	ToolCalls         *[]AgentCompletionsMessageAssistantToolCall `json:"tool_calls"`
	UpstreamID        string                                      `json:"upstream_id"`
	// Upstream usage for this assistant response (set by upstream clients).
	Usage AgentCompletionsResponseUpstreamUsage `json:"usage"`
}

An assistant response in a unary agent completion.

func (AgentCompletionsResponseUnaryAssistantResponse) SchemaTitle ¶ 

func (AgentCompletionsResponseUnaryAssistantResponse) SchemaTitle() string

func (*AgentCompletionsResponseUnaryAssistantResponse) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseUnaryAssistantResponse) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseUnaryAssistantResponse) Validate ¶ 

func (v AgentCompletionsResponseUnaryAssistantResponse) Validate() error

type AgentCompletionsResponseUnaryMessage ¶ 

type AgentCompletionsResponseUnaryMessage struct {
	Assistant *AgentCompletionsResponseUnaryAssistantResponse
	Tool      *AgentCompletionsResponseToolResponse
}

func (AgentCompletionsResponseUnaryMessage) MarshalJSON ¶ 

func (v AgentCompletionsResponseUnaryMessage) MarshalJSON() ([]byte, error)

func (AgentCompletionsResponseUnaryMessage) SchemaTitle ¶ 

func (AgentCompletionsResponseUnaryMessage) SchemaTitle() string

func (*AgentCompletionsResponseUnaryMessage) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseUnaryMessage) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseUnaryMessage) Validate ¶ 

func (v AgentCompletionsResponseUnaryMessage) Validate() error

type AgentCompletionsResponseUnaryObject ¶ 

type AgentCompletionsResponseUnaryObject struct {
	AgentCompletion string `validate:"omitempty,oneof=agent.completion"`
}

A agent completion object.

func (AgentCompletionsResponseUnaryObject) MarshalJSON ¶ 

func (v AgentCompletionsResponseUnaryObject) MarshalJSON() ([]byte, error)

func (AgentCompletionsResponseUnaryObject) SchemaTitle ¶ 

func (AgentCompletionsResponseUnaryObject) SchemaTitle() string

func (*AgentCompletionsResponseUnaryObject) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseUnaryObject) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseUnaryObject) Validate ¶ 

func (v AgentCompletionsResponseUnaryObject) Validate() error

type AgentCompletionsResponseUpstreamUsage ¶ 

type AgentCompletionsResponseUpstreamUsage struct {
	// Number of tokens in the completion.
	CompletionTokens uint64 `json:"completion_tokens" validate:"min=0,max=18446744073709551615"`
	// Detailed breakdown of completion tokens.
	CompletionTokensDetails *AgentCompletionsResponseCompletionTokensDetails `json:"completion_tokens_details,omitempty"`
	// The cost charged by ObjectiveAI for this request.
	Cost float64 `json:"cost" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Detailed cost breakdown.
	CostDetails *AgentCompletionsResponseCostDetails `json:"cost_details,omitempty"`
	// The multiplier applied to compute ObjectiveAI's charge.
	CostMultiplier float64 `json:"cost_multiplier" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Whether this request used Bring Your Own Key (BYOK).
	IsByok bool `json:"is_byok"`
	// Number of tokens in the prompt.
	PromptTokens uint64 `json:"prompt_tokens" validate:"min=0,max=18446744073709551615"`
	// Detailed breakdown of prompt tokens.
	PromptTokensDetails *AgentCompletionsResponsePromptTokensDetails `json:"prompt_tokens_details,omitempty"`
	// Total cost including ObjectiveAI's charge plus all upstream charges.
	// For BYOK requests, ObjectiveAI only charges the cost_multiplier difference,
	// but total_cost still includes what the upstream provider charged.
	TotalCost float64 `json:"total_cost" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Total tokens (prompt + completion).
	TotalTokens uint64 `json:"total_tokens" validate:"min=0,max=18446744073709551615"`
}

Token usage and cost information from an upstream provider.

This is the per-assistant-response usage yielded by upstream clients. It includes upstream-specific fields like `cost_multiplier` and `is_byok`.

func (*AgentCompletionsResponseUpstreamUsage) Push ¶ 

func (v *AgentCompletionsResponseUpstreamUsage) Push(other *AgentCompletionsResponseUpstreamUsage)

Push accumulates another UpstreamUsage into this one.

func (AgentCompletionsResponseUpstreamUsage) SchemaTitle ¶ 

func (AgentCompletionsResponseUpstreamUsage) SchemaTitle() string

func (*AgentCompletionsResponseUpstreamUsage) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseUpstreamUsage) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseUpstreamUsage) Validate ¶ 

func (v AgentCompletionsResponseUpstreamUsage) Validate() error

type AgentCompletionsResponseUsage ¶ 

type AgentCompletionsResponseUsage struct {
	// Total tokens generated across all assistant responses.
	CompletionTokens uint64 `json:"completion_tokens" validate:"min=0,max=18446744073709551615"`
	// Breakdown of completion tokens (reasoning, audio, etc.) if available.
	CompletionTokensDetails *AgentCompletionsResponseCompletionTokensDetails `json:"completion_tokens_details,omitempty"`
	// Cost charged by ObjectiveAI for this request.
	Cost float64 `json:"cost" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Breakdown of upstream and upstream_upstream costs if available.
	CostDetails *AgentCompletionsResponseCostDetails `json:"cost_details,omitempty"`
	// Total prompt tokens across all assistant responses.
	PromptTokens uint64 `json:"prompt_tokens" validate:"min=0,max=18446744073709551615"`
	// Breakdown of prompt tokens (cached, audio, etc.) if available.
	PromptTokensDetails *AgentCompletionsResponsePromptTokensDetails `json:"prompt_tokens_details,omitempty"`
	// Total cost including upstream provider charges. Only differs from `cost`
	// when using BYOK (Bring Your Own Key).
	TotalCost float64 `json:"total_cost" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Sum of completion and prompt tokens.
	TotalTokens uint64 `json:"total_tokens" validate:"min=0,max=18446744073709551615"`
}

Aggregated token and cost usage for an agent completion.

This is the "primary" usage type that aggregates across all upstream assistant responses within a single agent completion.

func (*AgentCompletionsResponseUsage) Push ¶ 

func (v *AgentCompletionsResponseUsage) Push(other *AgentCompletionsResponseUsage)

Push accumulates another Usage into this one.

func (AgentCompletionsResponseUsage) SchemaTitle ¶ 

func (AgentCompletionsResponseUsage) SchemaTitle() string

func (*AgentCompletionsResponseUsage) UnmarshalJSON ¶ 

func (v *AgentCompletionsResponseUsage) UnmarshalJSON(data []byte) error

func (AgentCompletionsResponseUsage) Validate ¶ 

func (v AgentCompletionsResponseUsage) Validate() error

type AgentContinuation ¶ 

type AgentContinuation struct {
	Openrouter     *AgentOpenrouterContinuation
	ClaudeAgentSdk *AgentClaudeAgentSdkContinuation
	CodexSdk       *AgentCodexSdkContinuation
	Mock           *AgentMockContinuation
}

Continuation state for multi-turn agent completions.

Returned in the final streaming chunk and in unary responses. Pass it back in the next request to continue the conversation. Serialized as base64-encoded JSON.

func (AgentContinuation) MarshalJSON ¶ 

func (v AgentContinuation) MarshalJSON() ([]byte, error)

func (AgentContinuation) SchemaTitle ¶ 

func (AgentContinuation) SchemaTitle() string

func (*AgentContinuation) UnmarshalJSON ¶ 

func (v *AgentContinuation) UnmarshalJSON(data []byte) error

func (AgentContinuation) Validate ¶ 

func (v AgentContinuation) Validate() error

type AgentGetAgentResponse ¶ 

type AgentGetAgentResponse struct {
	RemotePath
}

Response containing a single Agent with creation timestamp.

func AgentGetAgent ¶ 

func AgentGetAgent(ctx context.Context, c *Client, params RemotePathCommitOptional) (*AgentGetAgentResponse, error)

func (AgentGetAgentResponse) SchemaTitle ¶ 

func (AgentGetAgentResponse) SchemaTitle() string

func (AgentGetAgentResponse) Validate ¶ 

func (v AgentGetAgentResponse) Validate() error

type AgentInlineAgent ¶ 

type AgentInlineAgent struct {
	Openrouter     *AgentOpenrouterAgent
	ClaudeAgentSdk *AgentClaudeAgentSdkAgent
	CodexSdk       *AgentCodexSdkAgent
	Mock           *AgentMockAgent
}

A validated inline Agent with its computed content-addressed ID.

This is an untagged enum that dispatches to the per-upstream Agent.

func (AgentInlineAgent) MarshalJSON ¶ 

func (v AgentInlineAgent) MarshalJSON() ([]byte, error)

func (AgentInlineAgent) SchemaTitle ¶ 

func (AgentInlineAgent) SchemaTitle() string

func (*AgentInlineAgent) UnmarshalJSON ¶ 

func (v *AgentInlineAgent) UnmarshalJSON(data []byte) error

func (AgentInlineAgent) Validate ¶ 

func (v AgentInlineAgent) Validate() error

type AgentInlineAgentBase ¶ 

type AgentInlineAgentBase struct {
	Openrouter     *AgentOpenrouterAgentBase
	ClaudeAgentSdk *AgentClaudeAgentSdkAgentBase
	CodexSdk       *AgentCodexSdkAgentBase
	Mock           *AgentMockAgentBase
}

The base inline configuration for an Agent (without computed ID or metadata).

This is an untagged enum that dispatches to the per-upstream AgentBase. Deserialization tries each variant in order until one matches.

func (AgentInlineAgentBase) MarshalJSON ¶ 

func (v AgentInlineAgentBase) MarshalJSON() ([]byte, error)

func (AgentInlineAgentBase) SchemaTitle ¶ 

func (AgentInlineAgentBase) SchemaTitle() string

func (*AgentInlineAgentBase) UnmarshalJSON ¶ 

func (v *AgentInlineAgentBase) UnmarshalJSON(data []byte) error

func (AgentInlineAgentBase) Validate ¶ 

func (v AgentInlineAgentBase) Validate() error

type AgentInlineAgentBaseWithFallbacks ¶ 

type AgentInlineAgentBaseWithFallbacks struct {
	AgentInlineAgentBase
	// Fallback agents to try if the primary fails.
	Fallbacks *[]AgentInlineAgentBase `json:"fallbacks,omitempty"`
}

An [`InlineAgentBase`] with optional fallbacks (no description).

func (AgentInlineAgentBaseWithFallbacks) MarshalJSON ¶ 

func (v AgentInlineAgentBaseWithFallbacks) MarshalJSON() ([]byte, error)

func (AgentInlineAgentBaseWithFallbacks) SchemaTitle ¶ 

func (AgentInlineAgentBaseWithFallbacks) SchemaTitle() string

func (AgentInlineAgentBaseWithFallbacks) Validate ¶ 

func (v AgentInlineAgentBaseWithFallbacks) Validate() error

type AgentInlineAgentBaseWithFallbacksOrRemote ¶ 

type AgentInlineAgentBaseWithFallbacksOrRemote struct {
	AgentBase *AgentInlineAgentBaseWithFallbacks
	Remote    *RemotePath
}

An agent specification that is either an inline agent base with fallbacks or a remote path reference.

Used in swarm definitions to allow agents to be specified inline (with optional fallbacks) or resolved from a remote source via a hashmap during conversion.

func (AgentInlineAgentBaseWithFallbacksOrRemote) MarshalJSON ¶ 

func (v AgentInlineAgentBaseWithFallbacksOrRemote) MarshalJSON() ([]byte, error)

func (AgentInlineAgentBaseWithFallbacksOrRemote) SchemaTitle ¶ 

func (AgentInlineAgentBaseWithFallbacksOrRemote) SchemaTitle() string

func (*AgentInlineAgentBaseWithFallbacksOrRemote) UnmarshalJSON ¶ 

func (v *AgentInlineAgentBaseWithFallbacksOrRemote) UnmarshalJSON(data []byte) error

func (AgentInlineAgentBaseWithFallbacksOrRemote) Validate ¶ 

func (v AgentInlineAgentBaseWithFallbacksOrRemote) Validate() error

type AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional ¶ 

type AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional struct {
	AgentBase *AgentInlineAgentBaseWithFallbacks
	Remote    *RemotePathCommitOptional
}

Like [`InlineAgentBaseWithFallbacksOrRemote`] but with optional commit. Used in request types where commit resolution happens server-side.

func (AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional) MarshalJSON ¶ 

func (v AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional) MarshalJSON() ([]byte, error)

func (AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional) SchemaTitle ¶ 

func (AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional) SchemaTitle() string

func (*AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional) UnmarshalJSON ¶ 

func (v *AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional) UnmarshalJSON(data []byte) error

func (AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional) Validate ¶ 

func (v AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional) Validate() error

type AgentInlineAgentBaseWithFallbacksOrRemoteWithCount ¶ 

type AgentInlineAgentBaseWithFallbacksOrRemoteWithCount struct {
	AgentInlineAgentBaseWithFallbacksOrRemote
	// Number of instances of this agent in the swarm. Defaults to 1.
	Count uint64 `json:"count" validate:"min=0,max=18446744073709551615" default:"1"`
}

An [`InlineAgentBaseWithFallbacksOrRemote`] with a count (pre-validation swarm agent slot).

func (AgentInlineAgentBaseWithFallbacksOrRemoteWithCount) MarshalJSON ¶ 

func (v AgentInlineAgentBaseWithFallbacksOrRemoteWithCount) MarshalJSON() ([]byte, error)

func (AgentInlineAgentBaseWithFallbacksOrRemoteWithCount) SchemaTitle ¶ 

func (AgentInlineAgentBaseWithFallbacksOrRemoteWithCount) SchemaTitle() string

func (*AgentInlineAgentBaseWithFallbacksOrRemoteWithCount) UnmarshalJSON ¶ 

func (v *AgentInlineAgentBaseWithFallbacksOrRemoteWithCount) UnmarshalJSON(data []byte) error

func (AgentInlineAgentBaseWithFallbacksOrRemoteWithCount) Validate ¶ 

func (v AgentInlineAgentBaseWithFallbacksOrRemoteWithCount) Validate() error

type AgentInlineAgentWithFallbacks ¶ 

type AgentInlineAgentWithFallbacks struct {
	AgentInlineAgent
	// Fallback agents to try if the primary fails.
	Fallbacks *[]AgentInlineAgent `json:"fallbacks,omitempty"`
}

A validated [`InlineAgent`] with optional fallbacks (no description).

func (AgentInlineAgentWithFallbacks) MarshalJSON ¶ 

func (v AgentInlineAgentWithFallbacks) MarshalJSON() ([]byte, error)

func (AgentInlineAgentWithFallbacks) SchemaTitle ¶ 

func (AgentInlineAgentWithFallbacks) SchemaTitle() string

func (AgentInlineAgentWithFallbacks) Validate ¶ 

func (v AgentInlineAgentWithFallbacks) Validate() error

type AgentListAgentResponse ¶ 

type AgentListAgentResponse struct {
	// The list of Agent summaries.
	Data []RemotePath `json:"data"`
}

Response containing a list of Agents.

func AgentListAgents ¶ 

func AgentListAgents(ctx context.Context, c *Client, params AgentListAgentsRequest) (*AgentListAgentResponse, error)

func (AgentListAgentResponse) SchemaTitle ¶ 

func (AgentListAgentResponse) SchemaTitle() string

func (*AgentListAgentResponse) UnmarshalJSON ¶ 

func (v *AgentListAgentResponse) UnmarshalJSON(data []byte) error

func (AgentListAgentResponse) Validate ¶ 

func (v AgentListAgentResponse) Validate() error

type AgentListAgentsRequest ¶ 

type AgentListAgentsRequest struct {
	// Optional source filter for listing agents.
	Source *AgentListAgentsSource `json:"source,omitempty"`
}

Query parameters for the list agents endpoint.

func (AgentListAgentsRequest) SchemaTitle ¶ 

func (AgentListAgentsRequest) SchemaTitle() string

func (AgentListAgentsRequest) Validate ¶ 

func (v AgentListAgentsRequest) Validate() error

type AgentListAgentsSource ¶ 

type AgentListAgentsSource struct {
	All         *string `validate:"omitempty,oneof=all"`
	Mock        *string `validate:"omitempty,oneof=mock"`
	Filesystem  *string `validate:"omitempty,oneof=filesystem"`
	Objectiveai *string `validate:"omitempty,oneof=objectiveai"`
}

Source filter for listing agents.

func (AgentListAgentsSource) MarshalJSON ¶ 

func (v AgentListAgentsSource) MarshalJSON() ([]byte, error)

func (AgentListAgentsSource) SchemaTitle ¶ 

func (AgentListAgentsSource) SchemaTitle() string

func (*AgentListAgentsSource) UnmarshalJSON ¶ 

func (v *AgentListAgentsSource) UnmarshalJSON(data []byte) error

func (AgentListAgentsSource) Validate ¶ 

func (v AgentListAgentsSource) Validate() error

type AgentMcpServer ¶ 

type AgentMcpServer struct {
	// Whether this MCP server uses authorization.
	Authorization bool `json:"authorization" default:"false"`
	// The URL of the MCP server.
	URL string `json:"url"`
}

An MCP server that the agent can connect to.

func (AgentMcpServer) SchemaTitle ¶ 

func (AgentMcpServer) SchemaTitle() string

func (*AgentMcpServer) UnmarshalJSON ¶ 

func (v *AgentMcpServer) UnmarshalJSON(data []byte) error

func (AgentMcpServer) Validate ¶ 

func (v AgentMcpServer) Validate() error

type AgentMockAgent ¶ 

type AgentMockAgent struct {
	// If true, the mock client will return an error instead of a response.
	Error *bool `json:"error,omitempty"`
	// Probability (0-100) that the mock returns an error mid-stream.
	// Requires `error` to be `Some(true)`.
	ErrorProbability *uint32 `json:"error_probability,omitempty" validate:"omitempty,min=0,max=255"`
	// The deterministic content-addressed ID (22-character base62 string).
	ID string `json:"id"`
	// MCP servers the agent can connect to.
	MCPServers *[]AgentMcpServer `json:"mcp_servers,omitempty"`
	// Mock agent mode. Defaults to `default`.
	Mode *AgentMockMode `json:"mode,omitempty"`
	// The output mode for vector completions. Ignored for agent completions.
	OutputMode AgentMockOutputMode `json:"output_mode"`
	// Number of top log probabilities to return (2-20).
	//
	// **Vector completions only.** Ignored for agent completions.
	TopLogprobs *uint64 `json:"top_logprobs,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// The upstream provider marker.
	Upstream AgentMockUpstream `json:"upstream"`
}

A validated Mock Agent with its computed content-addressed ID.

func (AgentMockAgent) SchemaTitle ¶ 

func (AgentMockAgent) SchemaTitle() string

func (*AgentMockAgent) UnmarshalJSON ¶ 

func (v *AgentMockAgent) UnmarshalJSON(data []byte) error

func (AgentMockAgent) Validate ¶ 

func (v AgentMockAgent) Validate() error

type AgentMockAgentBase ¶ 

type AgentMockAgentBase struct {
	// If true, the mock client will return an error instead of a response.
	Error *bool `json:"error,omitempty"`
	// Probability (0-100) that the mock returns an error mid-stream.
	// Requires `error` to be `Some(true)`.
	ErrorProbability *uint32 `json:"error_probability,omitempty" validate:"omitempty,min=0,max=255"`
	// MCP servers the agent can connect to.
	MCPServers *[]AgentMcpServer `json:"mcp_servers,omitempty"`
	// Mock agent mode. Defaults to `default`.
	Mode *AgentMockMode `json:"mode,omitempty"`
	// The output mode for vector completions. Ignored for agent completions.
	OutputMode AgentMockOutputMode `json:"output_mode"`
	// Number of top log probabilities to return (2-20).
	//
	// **Vector completions only.** Ignored for agent completions.
	TopLogprobs *uint64 `json:"top_logprobs,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// The upstream provider marker.
	Upstream AgentMockUpstream `json:"upstream"`
}

The base configuration for a Mock Agent (without computed ID).

func (AgentMockAgentBase) SchemaTitle ¶ 

func (AgentMockAgentBase) SchemaTitle() string

func (*AgentMockAgentBase) UnmarshalJSON ¶ 

func (v *AgentMockAgentBase) UnmarshalJSON(data []byte) error

func (AgentMockAgentBase) Validate ¶ 

func (v AgentMockAgentBase) Validate() error

type AgentMockContinuation ¶ 

type AgentMockContinuation struct {
	MCPSessions OrderedMap[string, string]       `json:"mcp_sessions"`
	Messages    []AgentCompletionsMessageMessage `json:"messages"`
	Upstream    AgentMockUpstream                `json:"upstream"`
}

func (AgentMockContinuation) SchemaTitle ¶ 

func (AgentMockContinuation) SchemaTitle() string

func (*AgentMockContinuation) UnmarshalJSON ¶ 

func (v *AgentMockContinuation) UnmarshalJSON(data []byte) error

func (AgentMockContinuation) Validate ¶ 

func (v AgentMockContinuation) Validate() error

type AgentMockMode ¶ 

type AgentMockMode struct {
	Default              *string `validate:"omitempty,oneof=default"`
	Invention            *string `validate:"omitempty,oneof=invention"`
	LaboratoryBuilder    *string `validate:"omitempty,oneof=laboratory_builder"`
	LaboratoryEvaluation *string `validate:"omitempty,oneof=laboratory_evaluation"`
}

func (AgentMockMode) MarshalJSON ¶ 

func (v AgentMockMode) MarshalJSON() ([]byte, error)

func (AgentMockMode) SchemaTitle ¶ 

func (AgentMockMode) SchemaTitle() string

func (*AgentMockMode) UnmarshalJSON ¶ 

func (v *AgentMockMode) UnmarshalJSON(data []byte) error

func (AgentMockMode) Validate ¶ 

func (v AgentMockMode) Validate() error

type AgentMockOutputMode ¶ 

type AgentMockOutputMode struct {
	// The model is instructed via the prompt to output a specific key.
	//
	// This is the default and most widely supported mode.
	Instruction *AgentMockOutputModeInstruction `validate:"omitempty,oneof=instruction"`
	// A JSON schema response format is used with an enum of possible keys.
	//
	// Requires model support for structured JSON output.
	JsonSchema *AgentMockOutputModeJsonSchema `validate:"omitempty,oneof=json_schema"`
	// A forced tool call with an argument schema containing possible keys.
	//
	// Requires model support for tool/function calling.
	ToolCall *AgentMockOutputModeToolCall `validate:"omitempty,oneof=tool_call"`
}

The method used to constrain LLM output to valid response keys.

In vector completions, the model must select from a predefined set of responses. This enum controls *how* that constraint is enforced.

**Note:** This setting is only relevant for vector completions and is completely ignored for agent completions.

func (AgentMockOutputMode) MarshalJSON ¶ 

func (v AgentMockOutputMode) MarshalJSON() ([]byte, error)

func (AgentMockOutputMode) SchemaTitle ¶ 

func (AgentMockOutputMode) SchemaTitle() string

func (*AgentMockOutputMode) UnmarshalJSON ¶ 

func (v *AgentMockOutputMode) UnmarshalJSON(data []byte) error

func (AgentMockOutputMode) Validate ¶ 

func (v AgentMockOutputMode) Validate() error

type AgentMockOutputModeInstruction ¶ 

type AgentMockOutputModeInstruction string

func (AgentMockOutputModeInstruction) SchemaVariantTitle ¶ 

func (AgentMockOutputModeInstruction) SchemaVariantTitle() string

type AgentMockOutputModeJsonSchema ¶ 

type AgentMockOutputModeJsonSchema string

func (AgentMockOutputModeJsonSchema) SchemaVariantTitle ¶ 

func (AgentMockOutputModeJsonSchema) SchemaVariantTitle() string

type AgentMockOutputModeToolCall ¶ 

type AgentMockOutputModeToolCall string

func (AgentMockOutputModeToolCall) SchemaVariantTitle ¶ 

func (AgentMockOutputModeToolCall) SchemaVariantTitle() string

type AgentMockUpstream ¶ 

type AgentMockUpstream struct {
	Mock string `validate:"omitempty,oneof=mock"`
}

Mock upstream marker.

func (AgentMockUpstream) MarshalJSON ¶ 

func (v AgentMockUpstream) MarshalJSON() ([]byte, error)

func (AgentMockUpstream) SchemaTitle ¶ 

func (AgentMockUpstream) SchemaTitle() string

func (*AgentMockUpstream) UnmarshalJSON ¶ 

func (v *AgentMockUpstream) UnmarshalJSON(data []byte) error

func (AgentMockUpstream) Validate ¶ 

func (v AgentMockUpstream) Validate() error

type AgentOpenrouterAgent ¶ 

type AgentOpenrouterAgent struct {
	// Penalizes tokens based on their frequency in the output so far (-2.0 to 2.0).
	FrequencyPenalty *float64 `json:"frequency_penalty,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// The deterministic content-addressed ID (22-character base62 string).
	ID string `json:"id"`
	// Token ID to bias mapping (-100 to 100). Positive values increase likelihood.
	LogitBias *OrderedMap[string, int64] `json:"logit_bias,omitempty" validate:"omitempty,dive,min=-9223372036854775808,max=9223372036854775807"`
	// Maximum tokens in the completion.
	MaxCompletionTokens *uint64 `json:"max_completion_tokens,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// Maximum tokens (OpenRouter variant of max_completion_tokens).
	MaxTokens *uint64 `json:"max_tokens,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// MCP servers the agent can connect to.
	MCPServers *[]AgentMcpServer `json:"mcp_servers,omitempty"`
	// Minimum probability threshold for sampling (0.0 to 1.0).
	MinP *float64 `json:"min_p,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// The upstream language model identifier (e.g., `"gpt-4"`, `"claude-3-opus"`).
	Model string `json:"model"`
	// The output mode for vector completions. Ignored for agent completions.
	OutputMode AgentOpenrouterOutputMode `json:"output_mode" default:"instruction"`
	// Messages inserted after the leading chain of system/developer messages.
	PostSystemPrefixMessages *[]AgentCompletionsMessageMessage `json:"post_system_prefix_messages,omitempty"`
	// Messages prepended to the user's prompt.
	PrefixMessages *[]AgentCompletionsMessageMessage `json:"prefix_messages,omitempty"`
	// Penalizes tokens based on their presence in the output so far (-2.0 to 2.0).
	PresencePenalty *float64 `json:"presence_penalty,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Provider routing preferences.
	Provider *AgentOpenrouterProvider `json:"provider,omitempty"`
	// Reasoning/thinking configuration for supported models.
	Reasoning *AgentOpenrouterReasoning `json:"reasoning,omitempty"`
	// Repetition penalty (0.0 to 2.0). Values > 1.0 penalize repetition.
	RepetitionPenalty *float64 `json:"repetition_penalty,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Stop sequences that halt generation.
	Stop *AgentOpenrouterStop `json:"stop,omitempty"`
	// Messages appended after the user's prompt.
	SuffixMessages *[]AgentCompletionsMessageMessage `json:"suffix_messages,omitempty"`
	// Enable synthetic reasoning for non-reasoning LLMs.
	//
	// **Vector completions only.** Ignored for agent completions.
	SyntheticReasoning *bool `json:"synthetic_reasoning,omitempty"`
	// Sampling temperature (0.0 to 2.0). Higher = more random.
	Temperature *float64 `json:"temperature,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Top-a sampling parameter (0.0 to 1.0).
	TopA *float64 `json:"top_a,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Top-k sampling: only consider the k most likely tokens.
	TopK *uint64 `json:"top_k,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// Number of top log probabilities to return (2-20).
	//
	// **Vector completions only.** Ignored for agent completions.
	TopLogprobs *uint64 `json:"top_logprobs,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// Nucleus sampling probability (0.0 to 1.0).
	TopP *float64 `json:"top_p,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// The upstream provider marker.
	Upstream AgentOpenrouterUpstream `json:"upstream"`
	// Output verbosity hint for supported models.
	Verbosity *AgentOpenrouterVerbosity `json:"verbosity,omitempty"`
}

A validated OpenRouter Agent with its computed content-addressed ID.

func (AgentOpenrouterAgent) SchemaTitle ¶ 

func (AgentOpenrouterAgent) SchemaTitle() string

func (*AgentOpenrouterAgent) UnmarshalJSON ¶ 

func (v *AgentOpenrouterAgent) UnmarshalJSON(data []byte) error

func (AgentOpenrouterAgent) Validate ¶ 

func (v AgentOpenrouterAgent) Validate() error

type AgentOpenrouterAgentBase ¶ 

type AgentOpenrouterAgentBase struct {
	// Penalizes tokens based on their frequency in the output so far (-2.0 to 2.0).
	FrequencyPenalty *float64 `json:"frequency_penalty,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Token ID to bias mapping (-100 to 100). Positive values increase likelihood.
	LogitBias *OrderedMap[string, int64] `json:"logit_bias,omitempty" validate:"omitempty,dive,min=-9223372036854775808,max=9223372036854775807"`
	// Maximum tokens in the completion.
	MaxCompletionTokens *uint64 `json:"max_completion_tokens,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// Maximum tokens (OpenRouter variant of max_completion_tokens).
	MaxTokens *uint64 `json:"max_tokens,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// MCP servers the agent can connect to.
	MCPServers *[]AgentMcpServer `json:"mcp_servers,omitempty"`
	// Minimum probability threshold for sampling (0.0 to 1.0).
	MinP *float64 `json:"min_p,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// The upstream language model identifier (e.g., `"gpt-4"`, `"claude-3-opus"`).
	Model string `json:"model"`
	// The output mode for vector completions. Ignored for agent completions.
	OutputMode AgentOpenrouterOutputMode `json:"output_mode" default:"instruction"`
	// Messages inserted after the leading chain of system/developer messages.
	PostSystemPrefixMessages *[]AgentCompletionsMessageMessage `json:"post_system_prefix_messages,omitempty"`
	// Messages prepended to the user's prompt.
	PrefixMessages *[]AgentCompletionsMessageMessage `json:"prefix_messages,omitempty"`
	// Penalizes tokens based on their presence in the output so far (-2.0 to 2.0).
	PresencePenalty *float64 `json:"presence_penalty,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Provider routing preferences.
	Provider *AgentOpenrouterProvider `json:"provider,omitempty"`
	// Reasoning/thinking configuration for supported models.
	Reasoning *AgentOpenrouterReasoning `json:"reasoning,omitempty"`
	// Repetition penalty (0.0 to 2.0). Values > 1.0 penalize repetition.
	RepetitionPenalty *float64 `json:"repetition_penalty,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Stop sequences that halt generation.
	Stop *AgentOpenrouterStop `json:"stop,omitempty"`
	// Messages appended after the user's prompt.
	SuffixMessages *[]AgentCompletionsMessageMessage `json:"suffix_messages,omitempty"`
	// Enable synthetic reasoning for non-reasoning LLMs.
	//
	// **Vector completions only.** Ignored for agent completions.
	SyntheticReasoning *bool `json:"synthetic_reasoning,omitempty"`
	// Sampling temperature (0.0 to 2.0). Higher = more random.
	Temperature *float64 `json:"temperature,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Top-a sampling parameter (0.0 to 1.0).
	TopA *float64 `json:"top_a,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Top-k sampling: only consider the k most likely tokens.
	TopK *uint64 `json:"top_k,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// Number of top log probabilities to return (2-20).
	//
	// **Vector completions only.** Ignored for agent completions.
	TopLogprobs *uint64 `json:"top_logprobs,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// Nucleus sampling probability (0.0 to 1.0).
	TopP *float64 `json:"top_p,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// The upstream provider marker.
	Upstream AgentOpenrouterUpstream `json:"upstream"`
	// Output verbosity hint for supported models.
	Verbosity *AgentOpenrouterVerbosity `json:"verbosity,omitempty"`
}

The base configuration for an OpenRouter Agent (without computed ID).

func (AgentOpenrouterAgentBase) SchemaTitle ¶ 

func (AgentOpenrouterAgentBase) SchemaTitle() string

func (*AgentOpenrouterAgentBase) UnmarshalJSON ¶ 

func (v *AgentOpenrouterAgentBase) UnmarshalJSON(data []byte) error

func (AgentOpenrouterAgentBase) Validate ¶ 

func (v AgentOpenrouterAgentBase) Validate() error

type AgentOpenrouterContinuation ¶ 

type AgentOpenrouterContinuation struct {
	MCPSessions OrderedMap[string, string]       `json:"mcp_sessions"`
	Messages    []AgentCompletionsMessageMessage `json:"messages"`
	Upstream    AgentOpenrouterUpstream          `json:"upstream"`
}

func (AgentOpenrouterContinuation) SchemaTitle ¶ 

func (AgentOpenrouterContinuation) SchemaTitle() string

func (*AgentOpenrouterContinuation) UnmarshalJSON ¶ 

func (v *AgentOpenrouterContinuation) UnmarshalJSON(data []byte) error

func (AgentOpenrouterContinuation) Validate ¶ 

func (v AgentOpenrouterContinuation) Validate() error

type AgentOpenrouterOutputMode ¶ 

type AgentOpenrouterOutputMode struct {
	// The model is instructed via the prompt to output a specific key.
	//
	// This is the default and most widely supported mode.
	Instruction *AgentOpenrouterOutputModeInstruction `validate:"omitempty,oneof=instruction"`
	// A JSON schema response format is used with an enum of possible keys.
	//
	// Requires model support for structured JSON output.
	JsonSchema *AgentOpenrouterOutputModeJsonSchema `validate:"omitempty,oneof=json_schema"`
	// A forced tool call with an argument schema containing possible keys.
	//
	// Requires model support for tool/function calling.
	ToolCall *AgentOpenrouterOutputModeToolCall `validate:"omitempty,oneof=tool_call"`
}

The method used to constrain LLM output to valid response keys.

In vector completions, the model must select from a predefined set of responses. This enum controls *how* that constraint is enforced.

**Note:** This setting is only relevant for vector completions and is completely ignored for agent completions.

func (AgentOpenrouterOutputMode) MarshalJSON ¶ 

func (v AgentOpenrouterOutputMode) MarshalJSON() ([]byte, error)

func (AgentOpenrouterOutputMode) SchemaTitle ¶ 

func (AgentOpenrouterOutputMode) SchemaTitle() string

func (*AgentOpenrouterOutputMode) UnmarshalJSON ¶ 

func (v *AgentOpenrouterOutputMode) UnmarshalJSON(data []byte) error

func (AgentOpenrouterOutputMode) Validate ¶ 

func (v AgentOpenrouterOutputMode) Validate() error

type AgentOpenrouterOutputModeInstruction ¶ 

type AgentOpenrouterOutputModeInstruction string

func (AgentOpenrouterOutputModeInstruction) SchemaVariantTitle ¶ 

func (AgentOpenrouterOutputModeInstruction) SchemaVariantTitle() string

type AgentOpenrouterOutputModeJsonSchema ¶ 

type AgentOpenrouterOutputModeJsonSchema string

func (AgentOpenrouterOutputModeJsonSchema) SchemaVariantTitle ¶ 

func (AgentOpenrouterOutputModeJsonSchema) SchemaVariantTitle() string

type AgentOpenrouterOutputModeToolCall ¶ 

type AgentOpenrouterOutputModeToolCall string

func (AgentOpenrouterOutputModeToolCall) SchemaVariantTitle ¶ 

func (AgentOpenrouterOutputModeToolCall) SchemaVariantTitle() string

type AgentOpenrouterProvider ¶ 

type AgentOpenrouterProvider struct {
	// Whether to allow fallback to other providers if preferred ones fail.
	// Defaults to `true`.
	AllowFallbacks *bool `json:"allow_fallbacks,omitempty"`
	// Providers to exclude from routing.
	Ignore *[]string `json:"ignore,omitempty"`
	// Exclusive list of allowed providers. If set, only these providers are used.
	Only *[]string `json:"only,omitempty"`
	// Preferred provider order. Earlier providers are tried first.
	Order *[]string `json:"order,omitempty"`
	// Allowed model quantization levels.
	Quantizations *[]AgentOpenrouterProviderQuantization `json:"quantizations,omitempty"`
	// Whether to require that the provider supports all request parameters.
	// Defaults to `false`.
	RequireParameters *bool `json:"require_parameters,omitempty"`
}

Provider routing preferences.

Controls which providers are used and in what order when routing requests to upstream model hosts.

func (AgentOpenrouterProvider) SchemaTitle ¶ 

func (AgentOpenrouterProvider) SchemaTitle() string

func (AgentOpenrouterProvider) Validate ¶ 

func (v AgentOpenrouterProvider) Validate() error

type AgentOpenrouterProviderQuantization ¶ 

type AgentOpenrouterProviderQuantization struct {
	// 4-bit integer quantization.
	Int4 *AgentOpenrouterProviderQuantizationInt4 `validate:"omitempty,oneof=int4"`
	// 8-bit integer quantization.
	Int8 *AgentOpenrouterProviderQuantizationInt8 `validate:"omitempty,oneof=int8"`
	// 4-bit floating point quantization.
	Fp4 *AgentOpenrouterProviderQuantizationFp4 `validate:"omitempty,oneof=fp4"`
	// 6-bit floating point quantization.
	Fp6 *AgentOpenrouterProviderQuantizationFp6 `validate:"omitempty,oneof=fp6"`
	// 8-bit floating point quantization.
	Fp8 *AgentOpenrouterProviderQuantizationFp8 `validate:"omitempty,oneof=fp8"`
	// 16-bit floating point (half precision).
	Fp16 *AgentOpenrouterProviderQuantizationFp16 `validate:"omitempty,oneof=fp16"`
	// 16-bit brain floating point.
	Bf16 *AgentOpenrouterProviderQuantizationBf16 `validate:"omitempty,oneof=bf16"`
	// 32-bit floating point (full precision).
	Fp32 *AgentOpenrouterProviderQuantizationFp32 `validate:"omitempty,oneof=fp32"`
	// Unknown quantization level.
	Unknown *AgentOpenrouterProviderQuantizationUnknown `validate:"omitempty,oneof=unknown"`
}

Model quantization levels for provider filtering.

Quantization reduces model precision to decrease memory usage and increase inference speed, potentially at the cost of output quality.

func (AgentOpenrouterProviderQuantization) MarshalJSON ¶ 

func (v AgentOpenrouterProviderQuantization) MarshalJSON() ([]byte, error)

func (AgentOpenrouterProviderQuantization) SchemaTitle ¶ 

func (AgentOpenrouterProviderQuantization) SchemaTitle() string

func (*AgentOpenrouterProviderQuantization) UnmarshalJSON ¶ 

func (v *AgentOpenrouterProviderQuantization) UnmarshalJSON(data []byte) error

func (AgentOpenrouterProviderQuantization) Validate ¶ 

func (v AgentOpenrouterProviderQuantization) Validate() error

type AgentOpenrouterProviderQuantizationBf16 ¶ 

type AgentOpenrouterProviderQuantizationBf16 string

func (AgentOpenrouterProviderQuantizationBf16) SchemaVariantTitle ¶ 

func (AgentOpenrouterProviderQuantizationBf16) SchemaVariantTitle() string

type AgentOpenrouterProviderQuantizationFp4 ¶ 

type AgentOpenrouterProviderQuantizationFp4 string

func (AgentOpenrouterProviderQuantizationFp4) SchemaVariantTitle ¶ 

func (AgentOpenrouterProviderQuantizationFp4) SchemaVariantTitle() string

type AgentOpenrouterProviderQuantizationFp6 ¶ 

type AgentOpenrouterProviderQuantizationFp6 string

func (AgentOpenrouterProviderQuantizationFp6) SchemaVariantTitle ¶ 

func (AgentOpenrouterProviderQuantizationFp6) SchemaVariantTitle() string

type AgentOpenrouterProviderQuantizationFp8 ¶ 

type AgentOpenrouterProviderQuantizationFp8 string

func (AgentOpenrouterProviderQuantizationFp8) SchemaVariantTitle ¶ 

func (AgentOpenrouterProviderQuantizationFp8) SchemaVariantTitle() string

type AgentOpenrouterProviderQuantizationFp16 ¶ 

type AgentOpenrouterProviderQuantizationFp16 string

func (AgentOpenrouterProviderQuantizationFp16) SchemaVariantTitle ¶ 

func (AgentOpenrouterProviderQuantizationFp16) SchemaVariantTitle() string

type AgentOpenrouterProviderQuantizationFp32 ¶ 

type AgentOpenrouterProviderQuantizationFp32 string

func (AgentOpenrouterProviderQuantizationFp32) SchemaVariantTitle ¶ 

func (AgentOpenrouterProviderQuantizationFp32) SchemaVariantTitle() string

type AgentOpenrouterProviderQuantizationInt4 ¶ 

type AgentOpenrouterProviderQuantizationInt4 string

func (AgentOpenrouterProviderQuantizationInt4) SchemaVariantTitle ¶ 

func (AgentOpenrouterProviderQuantizationInt4) SchemaVariantTitle() string

type AgentOpenrouterProviderQuantizationInt8 ¶ 

type AgentOpenrouterProviderQuantizationInt8 string

func (AgentOpenrouterProviderQuantizationInt8) SchemaVariantTitle ¶ 

func (AgentOpenrouterProviderQuantizationInt8) SchemaVariantTitle() string

type AgentOpenrouterProviderQuantizationUnknown ¶ 

type AgentOpenrouterProviderQuantizationUnknown string

func (AgentOpenrouterProviderQuantizationUnknown) SchemaVariantTitle ¶ 

func (AgentOpenrouterProviderQuantizationUnknown) SchemaVariantTitle() string

type AgentOpenrouterReasoning ¶ 

type AgentOpenrouterReasoning struct {
	// The reasoning effort level.
	//
	// Only supported by some models.
	Effort *AgentOpenrouterReasoningEffort `json:"effort,omitempty"`
	// Whether reasoning is enabled. Defaults to `true` if other fields are set.
	Enabled *bool `json:"enabled,omitempty"`
	// Maximum tokens for the reasoning/thinking output.
	//
	// Only supported by some models.
	MaxTokens *uint64 `json:"max_tokens,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// Verbosity of reasoning summaries in the response.
	//
	// Only supported by some models.
	SummaryVerbosity *AgentOpenrouterReasoningSummaryVerbosity `json:"summary_verbosity,omitempty"`
}

Configuration for model reasoning/thinking capabilities.

Some models (like o1, o3, Claude with extended thinking) support explicit reasoning modes where they can "think" before responding. This struct configures those capabilities.

**Note:** The `max_tokens`, `effort`, and `summary_verbosity` fields are only supported by some models. Unsupported fields are silently ignored.

func (AgentOpenrouterReasoning) SchemaTitle ¶ 

func (AgentOpenrouterReasoning) SchemaTitle() string

func (AgentOpenrouterReasoning) Validate ¶ 

func (v AgentOpenrouterReasoning) Validate() error

type AgentOpenrouterReasoningEffort ¶ 

type AgentOpenrouterReasoningEffort struct {
	// No reasoning.
	None *AgentOpenrouterReasoningEffortNone `validate:"omitempty,oneof=none"`
	// Minimal reasoning effort.
	Minimal *AgentOpenrouterReasoningEffortMinimal `validate:"omitempty,oneof=minimal"`
	// Low reasoning effort.
	Low *AgentOpenrouterReasoningEffortLow `validate:"omitempty,oneof=low"`
	// Medium reasoning effort.
	Medium *AgentOpenrouterReasoningEffortMedium `validate:"omitempty,oneof=medium"`
	// High reasoning effort.
	High *AgentOpenrouterReasoningEffortHigh `validate:"omitempty,oneof=high"`
	// Maximum reasoning effort.
	Xhigh *AgentOpenrouterReasoningEffortXhigh `validate:"omitempty,oneof=xhigh"`
}

The level of effort the model should put into reasoning.

Only supported by some models.

func (AgentOpenrouterReasoningEffort) MarshalJSON ¶ 

func (v AgentOpenrouterReasoningEffort) MarshalJSON() ([]byte, error)

func (AgentOpenrouterReasoningEffort) SchemaTitle ¶ 

func (AgentOpenrouterReasoningEffort) SchemaTitle() string

func (*AgentOpenrouterReasoningEffort) UnmarshalJSON ¶ 

func (v *AgentOpenrouterReasoningEffort) UnmarshalJSON(data []byte) error

func (AgentOpenrouterReasoningEffort) Validate ¶ 

func (v AgentOpenrouterReasoningEffort) Validate() error

type AgentOpenrouterReasoningEffortHigh ¶ 

type AgentOpenrouterReasoningEffortHigh string

func (AgentOpenrouterReasoningEffortHigh) SchemaVariantTitle ¶ 

func (AgentOpenrouterReasoningEffortHigh) SchemaVariantTitle() string

type AgentOpenrouterReasoningEffortLow ¶ 

type AgentOpenrouterReasoningEffortLow string

func (AgentOpenrouterReasoningEffortLow) SchemaVariantTitle ¶ 

func (AgentOpenrouterReasoningEffortLow) SchemaVariantTitle() string

type AgentOpenrouterReasoningEffortMedium ¶ 

type AgentOpenrouterReasoningEffortMedium string

func (AgentOpenrouterReasoningEffortMedium) SchemaVariantTitle ¶ 

func (AgentOpenrouterReasoningEffortMedium) SchemaVariantTitle() string

type AgentOpenrouterReasoningEffortMinimal ¶ 

type AgentOpenrouterReasoningEffortMinimal string

func (AgentOpenrouterReasoningEffortMinimal) SchemaVariantTitle ¶ 

func (AgentOpenrouterReasoningEffortMinimal) SchemaVariantTitle() string

type AgentOpenrouterReasoningEffortNone ¶ 

type AgentOpenrouterReasoningEffortNone string

func (AgentOpenrouterReasoningEffortNone) SchemaVariantTitle ¶ 

func (AgentOpenrouterReasoningEffortNone) SchemaVariantTitle() string

type AgentOpenrouterReasoningEffortXhigh ¶ 

type AgentOpenrouterReasoningEffortXhigh string

func (AgentOpenrouterReasoningEffortXhigh) SchemaVariantTitle ¶ 

func (AgentOpenrouterReasoningEffortXhigh) SchemaVariantTitle() string

type AgentOpenrouterReasoningSummaryVerbosity ¶ 

type AgentOpenrouterReasoningSummaryVerbosity struct {
	// Let the model decide (default, normalized away).
	Auto *AgentOpenrouterReasoningSummaryVerbosityAuto `validate:"omitempty,oneof=auto"`
	// Brief summary of reasoning.
	Concise *AgentOpenrouterReasoningSummaryVerbosityConcise `validate:"omitempty,oneof=concise"`
	// Thorough summary of reasoning.
	Detailed *AgentOpenrouterReasoningSummaryVerbosityDetailed `validate:"omitempty,oneof=detailed"`
}

Verbosity of the reasoning summary included in responses.

Only supported by some models.

func (AgentOpenrouterReasoningSummaryVerbosity) MarshalJSON ¶ 

func (v AgentOpenrouterReasoningSummaryVerbosity) MarshalJSON() ([]byte, error)

func (AgentOpenrouterReasoningSummaryVerbosity) SchemaTitle ¶ 

func (AgentOpenrouterReasoningSummaryVerbosity) SchemaTitle() string

func (*AgentOpenrouterReasoningSummaryVerbosity) UnmarshalJSON ¶ 

func (v *AgentOpenrouterReasoningSummaryVerbosity) UnmarshalJSON(data []byte) error

func (AgentOpenrouterReasoningSummaryVerbosity) Validate ¶ 

func (v AgentOpenrouterReasoningSummaryVerbosity) Validate() error

type AgentOpenrouterReasoningSummaryVerbosityAuto ¶ 

type AgentOpenrouterReasoningSummaryVerbosityAuto string

func (AgentOpenrouterReasoningSummaryVerbosityAuto) SchemaVariantTitle ¶ 

func (AgentOpenrouterReasoningSummaryVerbosityAuto) SchemaVariantTitle() string

type AgentOpenrouterReasoningSummaryVerbosityConcise ¶ 

type AgentOpenrouterReasoningSummaryVerbosityConcise string

func (AgentOpenrouterReasoningSummaryVerbosityConcise) SchemaVariantTitle ¶ 

func (AgentOpenrouterReasoningSummaryVerbosityConcise) SchemaVariantTitle() string

type AgentOpenrouterReasoningSummaryVerbosityDetailed ¶ 

type AgentOpenrouterReasoningSummaryVerbosityDetailed string

func (AgentOpenrouterReasoningSummaryVerbosityDetailed) SchemaVariantTitle ¶ 

func (AgentOpenrouterReasoningSummaryVerbosityDetailed) SchemaVariantTitle() string

type AgentOpenrouterStop ¶ 

type AgentOpenrouterStop struct {
	// A single stop sequence.
	String *AgentOpenrouterStopString
	// Multiple stop sequences (up to 4 typically supported).
	Strings *AgentOpenrouterStopStrings
}

Stop sequences that terminate model generation.

When the model generates any of these sequences, it immediately stops producing further tokens.

func (AgentOpenrouterStop) MarshalJSON ¶ 

func (v AgentOpenrouterStop) MarshalJSON() ([]byte, error)

func (AgentOpenrouterStop) SchemaTitle ¶ 

func (AgentOpenrouterStop) SchemaTitle() string

func (*AgentOpenrouterStop) UnmarshalJSON ¶ 

func (v *AgentOpenrouterStop) UnmarshalJSON(data []byte) error

func (AgentOpenrouterStop) Validate ¶ 

func (v AgentOpenrouterStop) Validate() error

type AgentOpenrouterStopString ¶ 

type AgentOpenrouterStopString string

func (AgentOpenrouterStopString) SchemaVariantTitle ¶ 

func (AgentOpenrouterStopString) SchemaVariantTitle() string

type AgentOpenrouterStopStrings ¶ 

type AgentOpenrouterStopStrings []string

func (AgentOpenrouterStopStrings) SchemaVariantTitle ¶ 

func (AgentOpenrouterStopStrings) SchemaVariantTitle() string

type AgentOpenrouterUpstream ¶ 

type AgentOpenrouterUpstream struct {
	Openrouter string `validate:"omitempty,oneof=openrouter"`
}

OpenRouter upstream marker.

func (AgentOpenrouterUpstream) MarshalJSON ¶ 

func (v AgentOpenrouterUpstream) MarshalJSON() ([]byte, error)

func (AgentOpenrouterUpstream) SchemaTitle ¶ 

func (AgentOpenrouterUpstream) SchemaTitle() string

func (*AgentOpenrouterUpstream) UnmarshalJSON ¶ 

func (v *AgentOpenrouterUpstream) UnmarshalJSON(data []byte) error

func (AgentOpenrouterUpstream) Validate ¶ 

func (v AgentOpenrouterUpstream) Validate() error

type AgentOpenrouterVerbosity ¶ 

type AgentOpenrouterVerbosity struct {
	// Minimal output, concise responses.
	Low *AgentOpenrouterVerbosityLow `validate:"omitempty,oneof=low"`
	// Balanced output (default, normalized away during preparation).
	Medium *AgentOpenrouterVerbosityMedium `validate:"omitempty,oneof=medium"`
	// Detailed output with thorough explanations.
	High *AgentOpenrouterVerbosityHigh `validate:"omitempty,oneof=high"`
	// Maximum verbosity, most detailed output possible.
	Max *AgentOpenrouterVerbosityMax `validate:"omitempty,oneof=max"`
}

The verbosity level for model output.

This setting hints to the model how detailed its responses should be. Not all models support this parameter.

func (AgentOpenrouterVerbosity) MarshalJSON ¶ 

func (v AgentOpenrouterVerbosity) MarshalJSON() ([]byte, error)

func (AgentOpenrouterVerbosity) SchemaTitle ¶ 

func (AgentOpenrouterVerbosity) SchemaTitle() string

func (*AgentOpenrouterVerbosity) UnmarshalJSON ¶ 

func (v *AgentOpenrouterVerbosity) UnmarshalJSON(data []byte) error

func (AgentOpenrouterVerbosity) Validate ¶ 

func (v AgentOpenrouterVerbosity) Validate() error

type AgentOpenrouterVerbosityHigh ¶ 

type AgentOpenrouterVerbosityHigh string

func (AgentOpenrouterVerbosityHigh) SchemaVariantTitle ¶ 

func (AgentOpenrouterVerbosityHigh) SchemaVariantTitle() string

type AgentOpenrouterVerbosityLow ¶ 

type AgentOpenrouterVerbosityLow string

func (AgentOpenrouterVerbosityLow) SchemaVariantTitle ¶ 

func (AgentOpenrouterVerbosityLow) SchemaVariantTitle() string

type AgentOpenrouterVerbosityMax ¶ 

type AgentOpenrouterVerbosityMax string

func (AgentOpenrouterVerbosityMax) SchemaVariantTitle ¶ 

func (AgentOpenrouterVerbosityMax) SchemaVariantTitle() string

type AgentOpenrouterVerbosityMedium ¶ 

type AgentOpenrouterVerbosityMedium string

func (AgentOpenrouterVerbosityMedium) SchemaVariantTitle ¶ 

func (AgentOpenrouterVerbosityMedium) SchemaVariantTitle() string

type AgentOutputMode ¶ 

type AgentOutputMode struct {
	// The model is instructed via the prompt to output a specific key.
	//
	// This is the default and most widely supported mode.
	Instruction *AgentOutputModeInstruction `validate:"omitempty,oneof=instruction"`
	// A JSON schema response format is used with an enum of possible keys.
	//
	// Requires model support for structured JSON output.
	JsonSchema *AgentOutputModeJsonSchema `validate:"omitempty,oneof=json_schema"`
	// A forced tool call with an argument schema containing possible keys.
	//
	// Requires model support for tool/function calling.
	ToolCall *AgentOutputModeToolCall `validate:"omitempty,oneof=tool_call"`
}

The method used to constrain LLM output to valid response keys.

In vector completions, the model must select from a predefined set of responses. This enum controls *how* that constraint is enforced.

**Note:** This setting is only relevant for vector completions and is completely ignored for agent completions.

func (AgentOutputMode) MarshalJSON ¶ 

func (v AgentOutputMode) MarshalJSON() ([]byte, error)

func (AgentOutputMode) SchemaTitle ¶ 

func (AgentOutputMode) SchemaTitle() string

func (*AgentOutputMode) UnmarshalJSON ¶ 

func (v *AgentOutputMode) UnmarshalJSON(data []byte) error

func (AgentOutputMode) Validate ¶ 

func (v AgentOutputMode) Validate() error

type AgentOutputModeInstruction ¶ 

type AgentOutputModeInstruction string

func (AgentOutputModeInstruction) SchemaVariantTitle ¶ 

func (AgentOutputModeInstruction) SchemaVariantTitle() string

type AgentOutputModeJsonSchema ¶ 

type AgentOutputModeJsonSchema string

func (AgentOutputModeJsonSchema) SchemaVariantTitle ¶ 

func (AgentOutputModeJsonSchema) SchemaVariantTitle() string

type AgentOutputModeToolCall ¶ 

type AgentOutputModeToolCall string

func (AgentOutputModeToolCall) SchemaVariantTitle ¶ 

func (AgentOutputModeToolCall) SchemaVariantTitle() string

type AgentRemoteAgent ¶ 

type AgentRemoteAgent struct {
	AgentInlineAgent
	Description string `json:"description"`
}

A validated remote Agent with metadata and computed content-addressed ID.

func (AgentRemoteAgent) MarshalJSON ¶ 

func (v AgentRemoteAgent) MarshalJSON() ([]byte, error)

func (AgentRemoteAgent) SchemaTitle ¶ 

func (AgentRemoteAgent) SchemaTitle() string

func (*AgentRemoteAgent) UnmarshalJSON ¶ 

func (v *AgentRemoteAgent) UnmarshalJSON(data []byte) error

func (AgentRemoteAgent) Validate ¶ 

func (v AgentRemoteAgent) Validate() error

type AgentRemoteAgentBase ¶ 

type AgentRemoteAgentBase struct {
	AgentInlineAgentBase
	Description string `json:"description"`
}

A remote agent base definition with metadata.

Like [`InlineAgentBase`] but includes a description field for remote storage.

func (AgentRemoteAgentBase) MarshalJSON ¶ 

func (v AgentRemoteAgentBase) MarshalJSON() ([]byte, error)

func (AgentRemoteAgentBase) SchemaTitle ¶ 

func (AgentRemoteAgentBase) SchemaTitle() string

func (*AgentRemoteAgentBase) UnmarshalJSON ¶ 

func (v *AgentRemoteAgentBase) UnmarshalJSON(data []byte) error

func (AgentRemoteAgentBase) Validate ¶ 

func (v AgentRemoteAgentBase) Validate() error

type AgentRemoteAgentBaseWithFallbacks ¶ 

type AgentRemoteAgentBaseWithFallbacks struct {
	AgentInlineAgentBaseWithFallbacks
	Description string `json:"description"`
}

A remote agent base definition with description and optional fallbacks.

func (AgentRemoteAgentBaseWithFallbacks) MarshalJSON ¶ 

func (v AgentRemoteAgentBaseWithFallbacks) MarshalJSON() ([]byte, error)

func (AgentRemoteAgentBaseWithFallbacks) SchemaTitle ¶ 

func (AgentRemoteAgentBaseWithFallbacks) SchemaTitle() string

func (*AgentRemoteAgentBaseWithFallbacks) UnmarshalJSON ¶ 

func (v *AgentRemoteAgentBaseWithFallbacks) UnmarshalJSON(data []byte) error

func (AgentRemoteAgentBaseWithFallbacks) Validate ¶ 

func (v AgentRemoteAgentBaseWithFallbacks) Validate() error

type AgentRemoteAgentWithFallbacks ¶ 

type AgentRemoteAgentWithFallbacks struct {
	AgentInlineAgentWithFallbacks
	Description string `json:"description"`
}

A validated remote agent with description and optional fallbacks.

func (AgentRemoteAgentWithFallbacks) MarshalJSON ¶ 

func (v AgentRemoteAgentWithFallbacks) MarshalJSON() ([]byte, error)

func (AgentRemoteAgentWithFallbacks) SchemaTitle ¶ 

func (AgentRemoteAgentWithFallbacks) SchemaTitle() string

func (*AgentRemoteAgentWithFallbacks) UnmarshalJSON ¶ 

func (v *AgentRemoteAgentWithFallbacks) UnmarshalJSON(data []byte) error

func (AgentRemoteAgentWithFallbacks) Validate ¶ 

func (v AgentRemoteAgentWithFallbacks) Validate() error

type AgentUpstream ¶ 

type AgentUpstream struct {
	// Unknown Upstream.
	Unknown *AgentUpstreamUnknown `validate:"omitempty,oneof=unknown"`
	// OpenRouter Upstream.
	Openrouter *AgentUpstreamOpenrouter `validate:"omitempty,oneof=openrouter"`
	// Claude Agent SDK Upstream.
	ClaudeAgentSdk *AgentUpstreamClaudeAgentSdk `validate:"omitempty,oneof=claude_agent_sdk"`
	// Codex SDK Upstream.
	CodexSdk *AgentUpstreamCodexSdk `validate:"omitempty,oneof=codex_sdk"`
	// Mock Upstream.
	Mock *AgentUpstreamMock `validate:"omitempty,oneof=mock"`
}

Supported agent upstreams.

func (AgentUpstream) MarshalJSON ¶ 

func (v AgentUpstream) MarshalJSON() ([]byte, error)

func (AgentUpstream) SchemaTitle ¶ 

func (AgentUpstream) SchemaTitle() string

func (*AgentUpstream) UnmarshalJSON ¶ 

func (v *AgentUpstream) UnmarshalJSON(data []byte) error

func (AgentUpstream) Validate ¶ 

func (v AgentUpstream) Validate() error

type AgentUpstreamClaudeAgentSdk ¶ 

type AgentUpstreamClaudeAgentSdk string

func (AgentUpstreamClaudeAgentSdk) SchemaVariantTitle ¶ 

func (AgentUpstreamClaudeAgentSdk) SchemaVariantTitle() string

type AgentUpstreamCodexSdk ¶ 

type AgentUpstreamCodexSdk string

func (AgentUpstreamCodexSdk) SchemaVariantTitle ¶ 

func (AgentUpstreamCodexSdk) SchemaVariantTitle() string

type AgentUpstreamMock ¶ 

type AgentUpstreamMock string

func (AgentUpstreamMock) SchemaVariantTitle ¶ 

func (AgentUpstreamMock) SchemaVariantTitle() string

type AgentUpstreamOpenrouter ¶ 

type AgentUpstreamOpenrouter string

func (AgentUpstreamOpenrouter) SchemaVariantTitle ¶ 

func (AgentUpstreamOpenrouter) SchemaVariantTitle() string

type AgentUpstreamUnknown ¶ 

type AgentUpstreamUnknown string

func (AgentUpstreamUnknown) SchemaVariantTitle ¶ 

func (AgentUpstreamUnknown) SchemaVariantTitle() string

type AgentUsageAgentResponse ¶ 

type AgentUsageAgentResponse struct {
	// Total completion tokens generated.
	CompletionTokens uint64 `json:"completion_tokens" validate:"min=0,max=18446744073709551615"`
	// Total prompt tokens processed.
	PromptTokens uint64 `json:"prompt_tokens" validate:"min=0,max=18446744073709551615"`
	// Total number of requests made with this Agent.
	Requests uint64 `json:"requests" validate:"min=0,max=18446744073709551615"`
	// Total cost incurred.
	TotalCost float64 `json:"total_cost" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

Usage statistics for an Agent.

func AgentGetAgentUsage ¶ 

func AgentGetAgentUsage(ctx context.Context, c *Client, params RemotePathCommitOptional) (*AgentUsageAgentResponse, error)

func (AgentUsageAgentResponse) SchemaTitle ¶ 

func (AgentUsageAgentResponse) SchemaTitle() string

func (*AgentUsageAgentResponse) UnmarshalJSON ¶ 

func (v *AgentUsageAgentResponse) UnmarshalJSON(data []byte) error

func (AgentUsageAgentResponse) Validate ¶ 

func (v AgentUsageAgentResponse) Validate() error

type AuthApiKeyWithMetadata ¶ 

type AuthApiKeyWithMetadata struct {
	// The API key itself.
	APIKey PrefixedUuid `json:"api_key"`
	// The timestamp when the API key was created (RFC 3339 format).
	Created time.Time `json:"created"`
	// The user-provided description of the API key, or `None` if not provided.
	Description *string `json:"description"`
	// The timestamp when the API key was disabled, or `None` if it is active.
	Disabled *time.Time `json:"disabled"`
	// The timestamp when the API key expires, or `None` if it does not expire.
	Expires *time.Time `json:"expires"`
	// The user-provided name of the API key.
	Name string `json:"name"`
}

An ObjectiveAI API Key with associated metadata.

This struct contains the API key itself along with information about when it was created, when it expires (if ever), whether it has been disabled, and user-provided name and description.

func AuthCreateApiKey ¶ 

func AuthCreateApiKey(ctx context.Context, c *Client, params AuthCreateApiKeyRequest) (*AuthApiKeyWithMetadata, error)

func AuthDisableApiKey ¶ 

func AuthDisableApiKey(ctx context.Context, c *Client, params AuthDisableApiKeyRequest) (*AuthApiKeyWithMetadata, error)

func (AuthApiKeyWithMetadata) SchemaTitle ¶ 

func (AuthApiKeyWithMetadata) SchemaTitle() string

func (*AuthApiKeyWithMetadata) UnmarshalJSON ¶ 

func (v *AuthApiKeyWithMetadata) UnmarshalJSON(data []byte) error

func (AuthApiKeyWithMetadata) Validate ¶ 

func (v AuthApiKeyWithMetadata) Validate() error

type AuthCreateApiKeyRequest ¶ 

type AuthCreateApiKeyRequest struct {
	// An optional description providing additional context about the key's purpose.
	Description *string `json:"description"`
	// The expiration timestamp for the API key, or `None` for a non-expiring key.
	Expires *time.Time `json:"expires"`
	// A user-provided name to identify this API key.
	Name string `json:"name"`
}

Request to create a new API key.

Fields ¶

* `expires` - Optional expiration timestamp. If `None`, the key never expires. * `name` - A user-provided name for identifying the key. * `description` - Optional description providing additional context.

func (AuthCreateApiKeyRequest) SchemaTitle ¶ 

func (AuthCreateApiKeyRequest) SchemaTitle() string

func (*AuthCreateApiKeyRequest) UnmarshalJSON ¶ 

func (v *AuthCreateApiKeyRequest) UnmarshalJSON(data []byte) error

func (AuthCreateApiKeyRequest) Validate ¶ 

func (v AuthCreateApiKeyRequest) Validate() error

type AuthCreateOpenRouterByokApiKeyRequest ¶ 

type AuthCreateOpenRouterByokApiKeyRequest struct {
	// The OpenRouter API key to associate with the user's account.
	APIKey string `json:"api_key"`
}

Request to create or update an OpenRouter BYOK (Bring Your Own Key) API key.

This allows users to provide their own OpenRouter API key for routing requests through OpenRouter's model marketplace.

func (AuthCreateOpenRouterByokApiKeyRequest) SchemaTitle ¶ 

func (AuthCreateOpenRouterByokApiKeyRequest) SchemaTitle() string

func (*AuthCreateOpenRouterByokApiKeyRequest) UnmarshalJSON ¶ 

func (v *AuthCreateOpenRouterByokApiKeyRequest) UnmarshalJSON(data []byte) error

func (AuthCreateOpenRouterByokApiKeyRequest) Validate ¶ 

func (v AuthCreateOpenRouterByokApiKeyRequest) Validate() error

type AuthDisableApiKeyRequest ¶ 

type AuthDisableApiKeyRequest struct {
	// The API key to disable.
	APIKey PrefixedUuid `json:"api_key"`
}

Request to disable an existing API key.

Once disabled, the API key can no longer be used for authentication. This action is reversible only by creating a new key.

func (AuthDisableApiKeyRequest) SchemaTitle ¶ 

func (AuthDisableApiKeyRequest) SchemaTitle() string

func (*AuthDisableApiKeyRequest) UnmarshalJSON ¶ 

func (v *AuthDisableApiKeyRequest) UnmarshalJSON(data []byte) error

func (AuthDisableApiKeyRequest) Validate ¶ 

func (v AuthDisableApiKeyRequest) Validate() error

type AuthGetCreditsResponse ¶ 

type AuthGetCreditsResponse struct {
	// The current available credit balance.
	Credits float64 `json:"credits" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// The total amount of credits ever purchased.
	TotalCreditsPurchased float64 `json:"total_credits_purchased" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// The total amount of credits consumed by API usage.
	TotalCreditsUsed float64 `json:"total_credits_used" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

Response containing the user's credit balance information.

Credits are the billing unit for ObjectiveAI. This response provides a complete view of the user's credit status.

func AuthGetCredits ¶ 

func AuthGetCredits(ctx context.Context, c *Client) (*AuthGetCreditsResponse, error)

func (AuthGetCreditsResponse) SchemaTitle ¶ 

func (AuthGetCreditsResponse) SchemaTitle() string

func (*AuthGetCreditsResponse) UnmarshalJSON ¶ 

func (v *AuthGetCreditsResponse) UnmarshalJSON(data []byte) error

func (AuthGetCreditsResponse) Validate ¶ 

func (v AuthGetCreditsResponse) Validate() error

type AuthGetOpenRouterByokApiKeyResponse ¶ 

type AuthGetOpenRouterByokApiKeyResponse struct {
	// The OpenRouter API key, or `None` if not configured.
	APIKey *string `json:"api_key"`
}

Response containing the user's OpenRouter BYOK API key.

func AuthCreateOpenrouterByokApiKey ¶ 

func AuthCreateOpenrouterByokApiKey(ctx context.Context, c *Client, params AuthCreateOpenRouterByokApiKeyRequest) (*AuthGetOpenRouterByokApiKeyResponse, error)

func AuthGetOpenrouterByokApiKey ¶ 

func AuthGetOpenrouterByokApiKey(ctx context.Context, c *Client) (*AuthGetOpenRouterByokApiKeyResponse, error)

func (AuthGetOpenRouterByokApiKeyResponse) SchemaTitle ¶ 

func (AuthGetOpenRouterByokApiKeyResponse) SchemaTitle() string

func (AuthGetOpenRouterByokApiKeyResponse) Validate ¶ 

func (v AuthGetOpenRouterByokApiKeyResponse) Validate() error

type AuthListApiKeyItem ¶ 

type AuthListApiKeyItem struct {
	// The API key itself.
	APIKey PrefixedUuid `json:"api_key"`
	// The total cost incurred by this API key.
	Cost float64 `json:"cost" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// The timestamp when the API key was created (RFC 3339 format).
	Created time.Time `json:"created"`
	// The user-provided description of the API key, or `None` if not provided.
	Description *string `json:"description"`
	// The timestamp when the API key was disabled, or `None` if it is active.
	Disabled *time.Time `json:"disabled"`
	// The timestamp when the API key expires, or `None` if it does not expire.
	Expires *time.Time `json:"expires"`
	// The user-provided name of the API key.
	Name string `json:"name"`
}

An API key with metadata and accumulated cost information.

This extends [`ApiKeyWithMetadata`](super::ApiKeyWithMetadata) with the total cost incurred by requests using this key.

func (AuthListApiKeyItem) SchemaTitle ¶ 

func (AuthListApiKeyItem) SchemaTitle() string

func (*AuthListApiKeyItem) UnmarshalJSON ¶ 

func (v *AuthListApiKeyItem) UnmarshalJSON(data []byte) error

func (AuthListApiKeyItem) Validate ¶ 

func (v AuthListApiKeyItem) Validate() error

type AuthListApiKeyResponse ¶ 

type AuthListApiKeyResponse struct {
	// The list of API keys with their metadata and usage costs.
	Data []AuthListApiKeyItem `json:"data"`
}

Response containing a list of API keys.

func AuthListApiKeys ¶ 

func AuthListApiKeys(ctx context.Context, c *Client) (*AuthListApiKeyResponse, error)

func (AuthListApiKeyResponse) SchemaTitle ¶ 

func (AuthListApiKeyResponse) SchemaTitle() string

func (*AuthListApiKeyResponse) UnmarshalJSON ¶ 

func (v *AuthListApiKeyResponse) UnmarshalJSON(data []byte) error

func (AuthListApiKeyResponse) Validate ¶ 

func (v AuthListApiKeyResponse) Validate() error

type Client ¶ 

type Client struct {
	Address                  string
	Authorization            string
	UserAgent                string
	HTTPReferer              string
	XTitle                   string
	XGithubAuthorization     string
	XOpenrouterAuthorization string
	XMCPAuthorization        map[string]string
	XViewerSignature         string
	XViewerAddress           string
	XCommitAuthorName        string
	XCommitAuthorEmail       string
	HTTPClient               *http.Client
}

Client is the HTTP client for the ObjectiveAI API.

func NewClient ¶ 

func NewClient(opts ...func(*Client)) *Client

NewClient creates a new ObjectiveAI client. Fields fall back to environment variables, then defaults.

type Described ¶ 

type Described interface {
	SchemaTitle() string
	SchemaDescription() string
}

Described is implemented by every generated type. It provides metadata that cannot be derived from Go's type system. Methods use the Schema prefix to avoid conflicts with struct fields named "title" or "description".

type ErrorErrorCreateParams ¶ 

type ErrorErrorCreateParams struct {
	// Random seed for deterministic error generation.
	Seed *int64 `json:"seed,omitempty" validate:"omitempty,min=-9223372036854775808,max=9223372036854775807"`
	// Whether to stream the response.
	Stream *bool `json:"stream,omitempty"`
}

Request to trigger an error response for testing purposes.

func (ErrorErrorCreateParams) SchemaTitle ¶ 

func (ErrorErrorCreateParams) SchemaTitle() string

func (ErrorErrorCreateParams) Validate ¶ 

func (v ErrorErrorCreateParams) Validate() error

type ErrorErrorResponse ¶ 

type ErrorErrorResponse struct {
	// Whether the request completed successfully.
	Ok bool `json:"ok"`
}

Response from the error endpoint.

func ErrorCreateErrorUnary ¶ 

func ErrorCreateErrorUnary(ctx context.Context, c *Client, params ErrorErrorCreateParams) (*ErrorErrorResponse, error)

func (ErrorErrorResponse) SchemaTitle ¶ 

func (ErrorErrorResponse) SchemaTitle() string

func (*ErrorErrorResponse) UnmarshalJSON ¶ 

func (v *ErrorErrorResponse) UnmarshalJSON(data []byte) error

func (ErrorErrorResponse) Validate ¶ 

func (v ErrorErrorResponse) Validate() error

type ErrorResponseError ¶ 

type ErrorResponseError struct {
	// The HTTP status code of the error response.
	Code uint32 `json:"code" validate:"min=0,max=65535"`
	// The error message or details as a JSON value.
	Message JsonValue `json:"message"`
}

An error returned by the ObjectiveAI API.

This struct represents an API error response containing an HTTP status code and a message. The message can be any JSON value, allowing for both simple string errors and structured error objects.

func (*ErrorResponseError) Error ¶ 

func (e *ErrorResponseError) Error() string

Error implements the error interface for ErrorResponseError.

func (ErrorResponseError) SchemaTitle ¶ 

func (ErrorResponseError) SchemaTitle() string

func (*ErrorResponseError) UnmarshalJSON ¶ 

func (v *ErrorResponseError) UnmarshalJSON(data []byte) error

func (ErrorResponseError) Validate ¶ 

func (v ErrorResponseError) Validate() error

type FilesystemConfigAgentsConfig ¶ 

type FilesystemConfigAgentsConfig struct {
	Favorites *[]FilesystemConfigFavorite `json:"favorites,omitempty"`
}

func (FilesystemConfigAgentsConfig) SchemaTitle ¶ 

func (FilesystemConfigAgentsConfig) SchemaTitle() string

func (FilesystemConfigAgentsConfig) Validate ¶ 

func (v FilesystemConfigAgentsConfig) Validate() error

type FilesystemConfigApiConfig ¶ 

type FilesystemConfigApiConfig struct {
	Headers *FilesystemConfigApiHeadersConfig `json:"headers,omitempty"`
	Local   *FilesystemConfigApiLocalConfig   `json:"local,omitempty"`
	Mode    FilesystemConfigApiMode           `json:"mode" default:"local"`
	Remote  *FilesystemConfigApiRemoteConfig  `json:"remote,omitempty"`
}

func (FilesystemConfigApiConfig) SchemaTitle ¶ 

func (FilesystemConfigApiConfig) SchemaTitle() string

func (*FilesystemConfigApiConfig) UnmarshalJSON ¶ 

func (v *FilesystemConfigApiConfig) UnmarshalJSON(data []byte) error

func (FilesystemConfigApiConfig) Validate ¶ 

func (v FilesystemConfigApiConfig) Validate() error

type FilesystemConfigApiHeadersConfig ¶ 

type FilesystemConfigApiHeadersConfig struct {
	HTTPReferer               *string                     `json:"http_referer,omitempty"`
	UserAgent                 *string                     `json:"user_agent,omitempty"`
	XCommitAuthorEmail        *string                     `json:"x_commit_author_email,omitempty"`
	XCommitAuthorName         *string                     `json:"x_commit_author_name,omitempty"`
	XGithubAuthorization      *string                     `json:"x_github_authorization,omitempty"`
	XMCPAuthorization         *OrderedMap[string, string] `json:"x_mcp_authorization,omitempty"`
	XObjectiveaiAuthorization *string                     `json:"x_objectiveai_authorization,omitempty"`
	XOpenrouterAuthorization  *string                     `json:"x_openrouter_authorization,omitempty"`
	XTitle                    *string                     `json:"x_title,omitempty"`
	XViewerAddress            *string                     `json:"x_viewer_address,omitempty"`
	XViewerSignature          *string                     `json:"x_viewer_signature,omitempty"`
}

func (FilesystemConfigApiHeadersConfig) SchemaTitle ¶ 

func (FilesystemConfigApiHeadersConfig) SchemaTitle() string

func (FilesystemConfigApiHeadersConfig) Validate ¶ 

func (v FilesystemConfigApiHeadersConfig) Validate() error

type FilesystemConfigApiLocalConfig ¶ 

type FilesystemConfigApiLocalConfig struct {
	ClaudeAgentSDK *bool `json:"claude_agent_sdk,omitempty"`
}

func (FilesystemConfigApiLocalConfig) SchemaTitle ¶ 

func (FilesystemConfigApiLocalConfig) SchemaTitle() string

func (FilesystemConfigApiLocalConfig) Validate ¶ 

func (v FilesystemConfigApiLocalConfig) Validate() error

type FilesystemConfigApiMode ¶ 

type FilesystemConfigApiMode struct {
	Remote *string `validate:"omitempty,oneof=remote"`
	Local  *string `validate:"omitempty,oneof=local"`
}

func (FilesystemConfigApiMode) MarshalJSON ¶ 

func (v FilesystemConfigApiMode) MarshalJSON() ([]byte, error)

func (FilesystemConfigApiMode) SchemaTitle ¶ 

func (FilesystemConfigApiMode) SchemaTitle() string

func (*FilesystemConfigApiMode) UnmarshalJSON ¶ 

func (v *FilesystemConfigApiMode) UnmarshalJSON(data []byte) error

func (FilesystemConfigApiMode) Validate ¶ 

func (v FilesystemConfigApiMode) Validate() error

type FilesystemConfigApiRemoteConfig ¶ 

type FilesystemConfigApiRemoteConfig struct {
	ObjectiveaiAddress *string `json:"objectiveai_address,omitempty"`
}

func (FilesystemConfigApiRemoteConfig) SchemaTitle ¶ 

func (FilesystemConfigApiRemoteConfig) SchemaTitle() string

func (FilesystemConfigApiRemoteConfig) Validate ¶ 

func (v FilesystemConfigApiRemoteConfig) Validate() error

type FilesystemConfigConfig ¶ 

type FilesystemConfigConfig struct {
	Agents    *FilesystemConfigAgentsConfig    `json:"agents,omitempty"`
	API       *FilesystemConfigApiConfig       `json:"api,omitempty"`
	Functions *FilesystemConfigFunctionsConfig `json:"functions,omitempty"`
	Swarms    *FilesystemConfigSwarmsConfig    `json:"swarms,omitempty"`
	Viewer    *FilesystemConfigViewerConfig    `json:"viewer,omitempty"`
}

func (FilesystemConfigConfig) SchemaTitle ¶ 

func (FilesystemConfigConfig) SchemaTitle() string

func (FilesystemConfigConfig) Validate ¶ 

func (v FilesystemConfigConfig) Validate() error

type FilesystemConfigFavorite ¶ 

type FilesystemConfigFavorite struct {
	RemotePathCommitOptional
	Name string `json:"name"`
	Note string `json:"note"`
}

func (FilesystemConfigFavorite) MarshalJSON ¶ 

func (v FilesystemConfigFavorite) MarshalJSON() ([]byte, error)

func (FilesystemConfigFavorite) SchemaTitle ¶ 

func (FilesystemConfigFavorite) SchemaTitle() string

func (*FilesystemConfigFavorite) UnmarshalJSON ¶ 

func (v *FilesystemConfigFavorite) UnmarshalJSON(data []byte) error

func (FilesystemConfigFavorite) Validate ¶ 

func (v FilesystemConfigFavorite) Validate() error

type FilesystemConfigFunctionsConfig ¶ 

type FilesystemConfigFunctionsConfig struct {
	Favorites  *[]FilesystemConfigFavorite                `json:"favorites,omitempty"`
	Inventions *FilesystemConfigFunctionsInventionsConfig `json:"inventions,omitempty"`
	Profiles   *FilesystemConfigFunctionsProfilesConfig   `json:"profiles,omitempty"`
}

func (FilesystemConfigFunctionsConfig) SchemaTitle ¶ 

func (FilesystemConfigFunctionsConfig) SchemaTitle() string

func (FilesystemConfigFunctionsConfig) Validate ¶ 

func (v FilesystemConfigFunctionsConfig) Validate() error

type FilesystemConfigFunctionsInventionsConfig ¶ 

type FilesystemConfigFunctionsInventionsConfig struct {
	Remote Remote `json:"remote" default:"filesystem"`
}

func (FilesystemConfigFunctionsInventionsConfig) SchemaTitle ¶ 

func (FilesystemConfigFunctionsInventionsConfig) SchemaTitle() string

func (*FilesystemConfigFunctionsInventionsConfig) UnmarshalJSON ¶ 

func (v *FilesystemConfigFunctionsInventionsConfig) UnmarshalJSON(data []byte) error

func (FilesystemConfigFunctionsInventionsConfig) Validate ¶ 

func (v FilesystemConfigFunctionsInventionsConfig) Validate() error

type FilesystemConfigFunctionsProfilesConfig ¶ 

type FilesystemConfigFunctionsProfilesConfig struct {
	Favorites *[]FilesystemConfigFavorite                   `json:"favorites,omitempty"`
	Pairs     *FilesystemConfigFunctionsProfilesPairsConfig `json:"pairs,omitempty"`
}

func (FilesystemConfigFunctionsProfilesConfig) SchemaTitle ¶ 

func (FilesystemConfigFunctionsProfilesConfig) SchemaTitle() string

func (FilesystemConfigFunctionsProfilesConfig) Validate ¶ 

func (v FilesystemConfigFunctionsProfilesConfig) Validate() error

type FilesystemConfigFunctionsProfilesPairsConfig ¶ 

type FilesystemConfigFunctionsProfilesPairsConfig struct {
	Favorites *[]FilesystemConfigPairFavorite `json:"favorites,omitempty"`
}

func (FilesystemConfigFunctionsProfilesPairsConfig) SchemaTitle ¶ 

func (FilesystemConfigFunctionsProfilesPairsConfig) SchemaTitle() string

func (FilesystemConfigFunctionsProfilesPairsConfig) Validate ¶ 

func (v FilesystemConfigFunctionsProfilesPairsConfig) Validate() error

type FilesystemConfigPairFavorite ¶ 

type FilesystemConfigPairFavorite struct {
	Function RemotePathCommitOptional `json:"function"`
	Name     string                   `json:"name"`
	Note     string                   `json:"note"`
	Profile  RemotePathCommitOptional `json:"profile"`
}

func (FilesystemConfigPairFavorite) SchemaTitle ¶ 

func (FilesystemConfigPairFavorite) SchemaTitle() string

func (*FilesystemConfigPairFavorite) UnmarshalJSON ¶ 

func (v *FilesystemConfigPairFavorite) UnmarshalJSON(data []byte) error

func (FilesystemConfigPairFavorite) Validate ¶ 

func (v FilesystemConfigPairFavorite) Validate() error

type FilesystemConfigSwarmsConfig ¶ 

type FilesystemConfigSwarmsConfig struct {
	Favorites *[]FilesystemConfigFavorite `json:"favorites,omitempty"`
}

func (FilesystemConfigSwarmsConfig) SchemaTitle ¶ 

func (FilesystemConfigSwarmsConfig) SchemaTitle() string

func (FilesystemConfigSwarmsConfig) Validate ¶ 

func (v FilesystemConfigSwarmsConfig) Validate() error

type FilesystemConfigViewerConfig ¶ 

type FilesystemConfigViewerConfig struct {
	Local *FilesystemConfigViewerLocalConfig `json:"local,omitempty"`
	Mode  FilesystemConfigViewerMode         `json:"mode" default:"local"`
}

func (FilesystemConfigViewerConfig) SchemaTitle ¶ 

func (FilesystemConfigViewerConfig) SchemaTitle() string

func (*FilesystemConfigViewerConfig) UnmarshalJSON ¶ 

func (v *FilesystemConfigViewerConfig) UnmarshalJSON(data []byte) error

func (FilesystemConfigViewerConfig) Validate ¶ 

func (v FilesystemConfigViewerConfig) Validate() error

type FilesystemConfigViewerLocalConfig ¶ 

type FilesystemConfigViewerLocalConfig struct {
	Secret    *string `json:"secret,omitempty"`
	Signature *string `json:"signature,omitempty"`
}

func (FilesystemConfigViewerLocalConfig) SchemaTitle ¶ 

func (FilesystemConfigViewerLocalConfig) SchemaTitle() string

func (FilesystemConfigViewerLocalConfig) Validate ¶ 

func (v FilesystemConfigViewerLocalConfig) Validate() error

type FilesystemConfigViewerMode ¶ 

type FilesystemConfigViewerMode struct {
	Remote *string `validate:"omitempty,oneof=remote"`
	Local  *string `validate:"omitempty,oneof=local"`
}

func (FilesystemConfigViewerMode) MarshalJSON ¶ 

func (v FilesystemConfigViewerMode) MarshalJSON() ([]byte, error)

func (FilesystemConfigViewerMode) SchemaTitle ¶ 

func (FilesystemConfigViewerMode) SchemaTitle() string

func (*FilesystemConfigViewerMode) UnmarshalJSON ¶ 

func (v *FilesystemConfigViewerMode) UnmarshalJSON(data []byte) error

func (FilesystemConfigViewerMode) Validate ¶ 

func (v FilesystemConfigViewerMode) Validate() error

type FilesystemConfigViewerSecretSignaturePair ¶ 

type FilesystemConfigViewerSecretSignaturePair struct {
	// The secret for the viewer server.
	Secret string `json:"secret"`
	// The pre-computed signature for the API client (`sha256=<hex>`).
	Signature string `json:"signature"`
}

A generated secret/signature pair for viewer authentication.

The viewer server stores the `secret`. The API client stores the `signature`. The signature is `sha256=<hex of SHA256(secret)>`. The viewer server validates by computing SHA256(secret) and comparing against the incoming header value. Knowing the signature does not reveal the secret (preimage resistance).

func (FilesystemConfigViewerSecretSignaturePair) SchemaTitle ¶ 

func (FilesystemConfigViewerSecretSignaturePair) SchemaTitle() string

func (*FilesystemConfigViewerSecretSignaturePair) UnmarshalJSON ¶ 

func (v *FilesystemConfigViewerSecretSignaturePair) UnmarshalJSON(data []byte) error

func (FilesystemConfigViewerSecretSignaturePair) Validate ¶ 

func (v FilesystemConfigViewerSecretSignaturePair) Validate() error

type FilesystemLogsListItem ¶ 

type FilesystemLogsListItem struct {
	// Unix timestamp (seconds) when the log was created.
	Created uint64 `json:"created" validate:"min=0,max=18446744073709551615"`
	// The log ID (filename stem, e.g. `"fexec1-abc123-1712345678"`).
	ID string `json:"id"`
}

A single entry in a log listing.

func (FilesystemLogsListItem) SchemaTitle ¶ 

func (FilesystemLogsListItem) SchemaTitle() string

func (*FilesystemLogsListItem) UnmarshalJSON ¶ 

func (v *FilesystemLogsListItem) UnmarshalJSON(data []byte) error

func (FilesystemLogsListItem) Validate ¶ 

func (v FilesystemLogsListItem) Validate() error

type FunctionsAlphaInlineFunction ¶ 

type FunctionsAlphaInlineFunction struct {
	Scalar *FunctionsAlphaScalarInlineFunction
	Vector *FunctionsAlphaVectorInlineFunction
}

func (FunctionsAlphaInlineFunction) MarshalJSON ¶ 

func (v FunctionsAlphaInlineFunction) MarshalJSON() ([]byte, error)

func (FunctionsAlphaInlineFunction) SchemaTitle ¶ 

func (FunctionsAlphaInlineFunction) SchemaTitle() string

func (*FunctionsAlphaInlineFunction) UnmarshalJSON ¶ 

func (v *FunctionsAlphaInlineFunction) UnmarshalJSON(data []byte) error

func (FunctionsAlphaInlineFunction) Validate ¶ 

func (v FunctionsAlphaInlineFunction) Validate() error

type FunctionsAlphaRemoteFunction ¶ 

type FunctionsAlphaRemoteFunction struct {
	Scalar *FunctionsAlphaScalarRemoteFunction
	Vector *FunctionsAlphaVectorRemoteFunction
}

func (FunctionsAlphaRemoteFunction) MarshalJSON ¶ 

func (v FunctionsAlphaRemoteFunction) MarshalJSON() ([]byte, error)

func (FunctionsAlphaRemoteFunction) SchemaTitle ¶ 

func (FunctionsAlphaRemoteFunction) SchemaTitle() string

func (*FunctionsAlphaRemoteFunction) UnmarshalJSON ¶ 

func (v *FunctionsAlphaRemoteFunction) UnmarshalJSON(data []byte) error

func (FunctionsAlphaRemoteFunction) Validate ¶ 

func (v FunctionsAlphaRemoteFunction) Validate() error

type FunctionsAlphaScalarBranchTaskExpression ¶ 

type FunctionsAlphaScalarBranchTaskExpression struct {
	ScalarFunction            *FunctionsAlphaScalarBranchTaskExpressionScalarFunction
	PlaceholderScalarFunction *FunctionsAlphaScalarBranchTaskExpressionPlaceholderScalarFunction
}

func (FunctionsAlphaScalarBranchTaskExpression) MarshalJSON ¶ 

func (v FunctionsAlphaScalarBranchTaskExpression) MarshalJSON() ([]byte, error)

func (FunctionsAlphaScalarBranchTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaScalarBranchTaskExpression) SchemaTitle() string

func (*FunctionsAlphaScalarBranchTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaScalarBranchTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaScalarBranchTaskExpression) Validate ¶ 

func (v FunctionsAlphaScalarBranchTaskExpression) Validate() error

type FunctionsAlphaScalarBranchTaskExpressionPlaceholderScalarFunction ¶ 

type FunctionsAlphaScalarBranchTaskExpressionPlaceholderScalarFunction struct {
	FunctionsAlphaScalarPlaceholderScalarFunctionTaskExpression
	Type string `json:"type" validate:"oneof=placeholder.alpha.scalar.function"`
}

func (FunctionsAlphaScalarBranchTaskExpressionPlaceholderScalarFunction) MarshalJSON ¶ 

func (v FunctionsAlphaScalarBranchTaskExpressionPlaceholderScalarFunction) MarshalJSON() ([]byte, error)

func (FunctionsAlphaScalarBranchTaskExpressionPlaceholderScalarFunction) SchemaVariantTitle ¶ 

func (FunctionsAlphaScalarBranchTaskExpressionPlaceholderScalarFunction) SchemaVariantTitle() string

func (*FunctionsAlphaScalarBranchTaskExpressionPlaceholderScalarFunction) UnmarshalJSON ¶ 

func (v *FunctionsAlphaScalarBranchTaskExpressionPlaceholderScalarFunction) UnmarshalJSON(data []byte) error

type FunctionsAlphaScalarBranchTaskExpressionScalarFunction ¶ 

type FunctionsAlphaScalarBranchTaskExpressionScalarFunction struct {
	FunctionsAlphaScalarScalarFunctionTaskExpression
	Type string `json:"type" validate:"oneof=alpha.scalar.function"`
}

func (FunctionsAlphaScalarBranchTaskExpressionScalarFunction) MarshalJSON ¶ 

func (v FunctionsAlphaScalarBranchTaskExpressionScalarFunction) MarshalJSON() ([]byte, error)

func (FunctionsAlphaScalarBranchTaskExpressionScalarFunction) SchemaVariantTitle ¶ 

func (FunctionsAlphaScalarBranchTaskExpressionScalarFunction) SchemaVariantTitle() string

func (*FunctionsAlphaScalarBranchTaskExpressionScalarFunction) UnmarshalJSON ¶ 

func (v *FunctionsAlphaScalarBranchTaskExpressionScalarFunction) UnmarshalJSON(data []byte) error

type FunctionsAlphaScalarInlineFunction ¶ 

type FunctionsAlphaScalarInlineFunction struct {
	Branch *FunctionsAlphaScalarInlineFunctionBranch
	Leaf   *FunctionsAlphaScalarInlineFunctionLeaf
}

func (FunctionsAlphaScalarInlineFunction) MarshalJSON ¶ 

func (v FunctionsAlphaScalarInlineFunction) MarshalJSON() ([]byte, error)

func (FunctionsAlphaScalarInlineFunction) SchemaTitle ¶ 

func (FunctionsAlphaScalarInlineFunction) SchemaTitle() string

func (*FunctionsAlphaScalarInlineFunction) UnmarshalJSON ¶ 

func (v *FunctionsAlphaScalarInlineFunction) UnmarshalJSON(data []byte) error

func (FunctionsAlphaScalarInlineFunction) Validate ¶ 

func (v FunctionsAlphaScalarInlineFunction) Validate() error

type FunctionsAlphaScalarInlineFunctionBranch ¶ 

type FunctionsAlphaScalarInlineFunctionBranch struct {
	Tasks []FunctionsAlphaScalarBranchTaskExpression `json:"tasks"`
	Type  string                                     `json:"type" validate:"oneof=alpha.scalar.branch.function"`
}

func (FunctionsAlphaScalarInlineFunctionBranch) SchemaVariantTitle ¶ 

func (FunctionsAlphaScalarInlineFunctionBranch) SchemaVariantTitle() string

func (*FunctionsAlphaScalarInlineFunctionBranch) UnmarshalJSON ¶ 

func (v *FunctionsAlphaScalarInlineFunctionBranch) UnmarshalJSON(data []byte) error

type FunctionsAlphaScalarInlineFunctionLeaf ¶ 

type FunctionsAlphaScalarInlineFunctionLeaf struct {
	Tasks []FunctionsAlphaScalarLeafTaskExpression `json:"tasks"`
	Type  string                                   `json:"type" validate:"oneof=alpha.scalar.leaf.function"`
}

func (FunctionsAlphaScalarInlineFunctionLeaf) SchemaVariantTitle ¶ 

func (FunctionsAlphaScalarInlineFunctionLeaf) SchemaVariantTitle() string

func (*FunctionsAlphaScalarInlineFunctionLeaf) UnmarshalJSON ¶ 

func (v *FunctionsAlphaScalarInlineFunctionLeaf) UnmarshalJSON(data []byte) error

type FunctionsAlphaScalarLeafTaskExpression ¶ 

type FunctionsAlphaScalarLeafTaskExpression struct {
	FunctionsAlphaScalarVectorCompletionTaskExpression
	Type string `json:"type" validate:"oneof=vector.completion"`
}

func (FunctionsAlphaScalarLeafTaskExpression) MarshalJSON ¶ 

func (v FunctionsAlphaScalarLeafTaskExpression) MarshalJSON() ([]byte, error)

func (FunctionsAlphaScalarLeafTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaScalarLeafTaskExpression) SchemaTitle() string

func (*FunctionsAlphaScalarLeafTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaScalarLeafTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaScalarLeafTaskExpression) Validate ¶ 

func (v FunctionsAlphaScalarLeafTaskExpression) Validate() error

type FunctionsAlphaScalarPartialPlaceholderBranchTaskExpression ¶ 

type FunctionsAlphaScalarPartialPlaceholderBranchTaskExpression struct {
	FunctionsAlphaScalarPartialPlaceholderScalarFunctionTaskExpression
	Type string `json:"type" validate:"oneof=placeholder.alpha.scalar.function"`
}

func (FunctionsAlphaScalarPartialPlaceholderBranchTaskExpression) MarshalJSON ¶ 

func (v FunctionsAlphaScalarPartialPlaceholderBranchTaskExpression) MarshalJSON() ([]byte, error)

func (FunctionsAlphaScalarPartialPlaceholderBranchTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaScalarPartialPlaceholderBranchTaskExpression) SchemaTitle() string

func (*FunctionsAlphaScalarPartialPlaceholderBranchTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaScalarPartialPlaceholderBranchTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaScalarPartialPlaceholderBranchTaskExpression) Validate ¶ 

func (v FunctionsAlphaScalarPartialPlaceholderBranchTaskExpression) Validate() error

type FunctionsAlphaScalarPartialPlaceholderScalarFunctionTaskExpression ¶ 

type FunctionsAlphaScalarPartialPlaceholderScalarFunctionTaskExpression struct {
	Input       FunctionsExpressionExpression        `json:"input"`
	InputSchema FunctionsExpressionObjectInputSchema `json:"input_schema"`
	Skip        *FunctionsExpressionExpression       `json:"skip,omitempty"`
	Spec        string                               `json:"spec"`
}

func (FunctionsAlphaScalarPartialPlaceholderScalarFunctionTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaScalarPartialPlaceholderScalarFunctionTaskExpression) SchemaTitle() string

func (*FunctionsAlphaScalarPartialPlaceholderScalarFunctionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaScalarPartialPlaceholderScalarFunctionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaScalarPartialPlaceholderScalarFunctionTaskExpression) Validate ¶ 

func (v FunctionsAlphaScalarPartialPlaceholderScalarFunctionTaskExpression) Validate() error

type FunctionsAlphaScalarPlaceholderScalarFunctionTaskExpression ¶ 

type FunctionsAlphaScalarPlaceholderScalarFunctionTaskExpression struct {
	Depth          uint64                               `json:"depth" validate:"min=0,max=18446744073709551615"`
	Input          FunctionsExpressionExpression        `json:"input"`
	InputSchema    FunctionsExpressionObjectInputSchema `json:"input_schema"`
	MaxBranchWidth uint64                               `json:"max_branch_width" validate:"min=0,max=18446744073709551615"`
	MaxLeafWidth   uint64                               `json:"max_leaf_width" validate:"min=0,max=18446744073709551615"`
	MinBranchWidth uint64                               `json:"min_branch_width" validate:"min=0,max=18446744073709551615"`
	MinLeafWidth   uint64                               `json:"min_leaf_width" validate:"min=0,max=18446744073709551615"`
	Name           string                               `json:"name"`
	Skip           *FunctionsExpressionExpression       `json:"skip,omitempty"`
	Spec           string                               `json:"spec"`
}

func (FunctionsAlphaScalarPlaceholderScalarFunctionTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaScalarPlaceholderScalarFunctionTaskExpression) SchemaTitle() string

func (*FunctionsAlphaScalarPlaceholderScalarFunctionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaScalarPlaceholderScalarFunctionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaScalarPlaceholderScalarFunctionTaskExpression) Validate ¶ 

func (v FunctionsAlphaScalarPlaceholderScalarFunctionTaskExpression) Validate() error

type FunctionsAlphaScalarRemoteFunction ¶ 

type FunctionsAlphaScalarRemoteFunction struct {
	Branch *FunctionsAlphaScalarRemoteFunctionBranch
	Leaf   *FunctionsAlphaScalarRemoteFunctionLeaf
}

func (FunctionsAlphaScalarRemoteFunction) MarshalJSON ¶ 

func (v FunctionsAlphaScalarRemoteFunction) MarshalJSON() ([]byte, error)

func (FunctionsAlphaScalarRemoteFunction) SchemaTitle ¶ 

func (FunctionsAlphaScalarRemoteFunction) SchemaTitle() string

func (*FunctionsAlphaScalarRemoteFunction) UnmarshalJSON ¶ 

func (v *FunctionsAlphaScalarRemoteFunction) UnmarshalJSON(data []byte) error

func (FunctionsAlphaScalarRemoteFunction) Validate ¶ 

func (v FunctionsAlphaScalarRemoteFunction) Validate() error

type FunctionsAlphaScalarRemoteFunctionBranch ¶ 

type FunctionsAlphaScalarRemoteFunctionBranch struct {
	Description string                                     `json:"description"`
	InputSchema FunctionsExpressionObjectInputSchema       `json:"input_schema"`
	Tasks       []FunctionsAlphaScalarBranchTaskExpression `json:"tasks"`
	Type        string                                     `json:"type" validate:"oneof=alpha.scalar.branch.function"`
}

func (FunctionsAlphaScalarRemoteFunctionBranch) SchemaVariantTitle ¶ 

func (FunctionsAlphaScalarRemoteFunctionBranch) SchemaVariantTitle() string

func (*FunctionsAlphaScalarRemoteFunctionBranch) UnmarshalJSON ¶ 

func (v *FunctionsAlphaScalarRemoteFunctionBranch) UnmarshalJSON(data []byte) error

type FunctionsAlphaScalarRemoteFunctionLeaf ¶ 

type FunctionsAlphaScalarRemoteFunctionLeaf struct {
	Description string                                   `json:"description"`
	InputSchema FunctionsExpressionObjectInputSchema     `json:"input_schema"`
	Tasks       []FunctionsAlphaScalarLeafTaskExpression `json:"tasks"`
	Type        string                                   `json:"type" validate:"oneof=alpha.scalar.leaf.function"`
}

func (FunctionsAlphaScalarRemoteFunctionLeaf) SchemaVariantTitle ¶ 

func (FunctionsAlphaScalarRemoteFunctionLeaf) SchemaVariantTitle() string

func (*FunctionsAlphaScalarRemoteFunctionLeaf) UnmarshalJSON ¶ 

func (v *FunctionsAlphaScalarRemoteFunctionLeaf) UnmarshalJSON(data []byte) error

type FunctionsAlphaScalarScalarFunctionTaskExpression ¶ 

type FunctionsAlphaScalarScalarFunctionTaskExpression struct {
	RemotePath
	Input FunctionsExpressionExpression  `json:"input"`
	Skip  *FunctionsExpressionExpression `json:"skip,omitempty"`
}

func (FunctionsAlphaScalarScalarFunctionTaskExpression) MarshalJSON ¶ 

func (v FunctionsAlphaScalarScalarFunctionTaskExpression) MarshalJSON() ([]byte, error)

func (FunctionsAlphaScalarScalarFunctionTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaScalarScalarFunctionTaskExpression) SchemaTitle() string

func (*FunctionsAlphaScalarScalarFunctionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaScalarScalarFunctionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaScalarScalarFunctionTaskExpression) Validate ¶ 

func (v FunctionsAlphaScalarScalarFunctionTaskExpression) Validate() error

type FunctionsAlphaScalarVectorCompletionTaskExpression ¶ 

type FunctionsAlphaScalarVectorCompletionTaskExpression struct {
	Messages  FunctionsExpressionExpression        `json:"messages"`
	Responses []AgentCompletionsMessageRichContent `json:"responses"`
	Skip      *FunctionsExpressionExpression       `json:"skip,omitempty"`
}

func (FunctionsAlphaScalarVectorCompletionTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaScalarVectorCompletionTaskExpression) SchemaTitle() string

func (*FunctionsAlphaScalarVectorCompletionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaScalarVectorCompletionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaScalarVectorCompletionTaskExpression) Validate ¶ 

func (v FunctionsAlphaScalarVectorCompletionTaskExpression) Validate() error

type FunctionsAlphaVectorBranchTaskExpression ¶ 

type FunctionsAlphaVectorBranchTaskExpression struct {
	ScalarFunction            *FunctionsAlphaVectorBranchTaskExpressionScalarFunction
	VectorFunction            *FunctionsAlphaVectorBranchTaskExpressionVectorFunction
	PlaceholderScalarFunction *FunctionsAlphaVectorBranchTaskExpressionPlaceholderScalarFunction
	PlaceholderVectorFunction *FunctionsAlphaVectorBranchTaskExpressionPlaceholderVectorFunction
}

func (FunctionsAlphaVectorBranchTaskExpression) MarshalJSON ¶ 

func (v FunctionsAlphaVectorBranchTaskExpression) MarshalJSON() ([]byte, error)

func (FunctionsAlphaVectorBranchTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaVectorBranchTaskExpression) SchemaTitle() string

func (*FunctionsAlphaVectorBranchTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorBranchTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaVectorBranchTaskExpression) Validate ¶ 

func (v FunctionsAlphaVectorBranchTaskExpression) Validate() error

type FunctionsAlphaVectorBranchTaskExpressionPlaceholderScalarFunction ¶ 

type FunctionsAlphaVectorBranchTaskExpressionPlaceholderScalarFunction struct {
	FunctionsAlphaVectorPlaceholderScalarFunctionTaskExpression
	Type string `json:"type" validate:"oneof=placeholder.alpha.scalar.function"`
}

func (FunctionsAlphaVectorBranchTaskExpressionPlaceholderScalarFunction) MarshalJSON ¶ 

func (v FunctionsAlphaVectorBranchTaskExpressionPlaceholderScalarFunction) MarshalJSON() ([]byte, error)

func (FunctionsAlphaVectorBranchTaskExpressionPlaceholderScalarFunction) SchemaVariantTitle ¶ 

func (FunctionsAlphaVectorBranchTaskExpressionPlaceholderScalarFunction) SchemaVariantTitle() string

func (*FunctionsAlphaVectorBranchTaskExpressionPlaceholderScalarFunction) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorBranchTaskExpressionPlaceholderScalarFunction) UnmarshalJSON(data []byte) error

type FunctionsAlphaVectorBranchTaskExpressionPlaceholderVectorFunction ¶ 

type FunctionsAlphaVectorBranchTaskExpressionPlaceholderVectorFunction struct {
	FunctionsAlphaVectorPlaceholderVectorFunctionTaskExpression
	Type string `json:"type" validate:"oneof=placeholder.alpha.vector.function"`
}

func (FunctionsAlphaVectorBranchTaskExpressionPlaceholderVectorFunction) MarshalJSON ¶ 

func (v FunctionsAlphaVectorBranchTaskExpressionPlaceholderVectorFunction) MarshalJSON() ([]byte, error)

func (FunctionsAlphaVectorBranchTaskExpressionPlaceholderVectorFunction) SchemaVariantTitle ¶ 

func (FunctionsAlphaVectorBranchTaskExpressionPlaceholderVectorFunction) SchemaVariantTitle() string

func (*FunctionsAlphaVectorBranchTaskExpressionPlaceholderVectorFunction) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorBranchTaskExpressionPlaceholderVectorFunction) UnmarshalJSON(data []byte) error

type FunctionsAlphaVectorBranchTaskExpressionScalarFunction ¶ 

type FunctionsAlphaVectorBranchTaskExpressionScalarFunction struct {
	FunctionsAlphaVectorScalarFunctionTaskExpression
	Type string `json:"type" validate:"oneof=alpha.scalar.function"`
}

func (FunctionsAlphaVectorBranchTaskExpressionScalarFunction) MarshalJSON ¶ 

func (v FunctionsAlphaVectorBranchTaskExpressionScalarFunction) MarshalJSON() ([]byte, error)

func (FunctionsAlphaVectorBranchTaskExpressionScalarFunction) SchemaVariantTitle ¶ 

func (FunctionsAlphaVectorBranchTaskExpressionScalarFunction) SchemaVariantTitle() string

func (*FunctionsAlphaVectorBranchTaskExpressionScalarFunction) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorBranchTaskExpressionScalarFunction) UnmarshalJSON(data []byte) error

type FunctionsAlphaVectorBranchTaskExpressionVectorFunction ¶ 

type FunctionsAlphaVectorBranchTaskExpressionVectorFunction struct {
	FunctionsAlphaVectorVectorFunctionTaskExpression
	Type string `json:"type" validate:"oneof=alpha.vector.function"`
}

func (FunctionsAlphaVectorBranchTaskExpressionVectorFunction) MarshalJSON ¶ 

func (v FunctionsAlphaVectorBranchTaskExpressionVectorFunction) MarshalJSON() ([]byte, error)

func (FunctionsAlphaVectorBranchTaskExpressionVectorFunction) SchemaVariantTitle ¶ 

func (FunctionsAlphaVectorBranchTaskExpressionVectorFunction) SchemaVariantTitle() string

func (*FunctionsAlphaVectorBranchTaskExpressionVectorFunction) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorBranchTaskExpressionVectorFunction) UnmarshalJSON(data []byte) error

type FunctionsAlphaVectorExpressionVectorFunctionInputSchema ¶ 

type FunctionsAlphaVectorExpressionVectorFunctionInputSchema struct {
	Context *FunctionsExpressionObjectInputSchema `json:"context,omitempty"`
	Items   FunctionsExpressionInputSchema        `json:"items"`
}

func (FunctionsAlphaVectorExpressionVectorFunctionInputSchema) SchemaTitle ¶ 

func (FunctionsAlphaVectorExpressionVectorFunctionInputSchema) SchemaTitle() string

func (*FunctionsAlphaVectorExpressionVectorFunctionInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorExpressionVectorFunctionInputSchema) UnmarshalJSON(data []byte) error

func (FunctionsAlphaVectorExpressionVectorFunctionInputSchema) Validate ¶ 

func (v FunctionsAlphaVectorExpressionVectorFunctionInputSchema) Validate() error

type FunctionsAlphaVectorExpressionVectorFunctionInputValue ¶ 

type FunctionsAlphaVectorExpressionVectorFunctionInputValue struct {
	Context *OrderedMap[string, FunctionsExpressionInputValue] `json:"context,omitempty"`
	Items   []FunctionsExpressionInputValue                    `json:"items"`
}

func (FunctionsAlphaVectorExpressionVectorFunctionInputValue) SchemaTitle ¶ 

func (FunctionsAlphaVectorExpressionVectorFunctionInputValue) SchemaTitle() string

func (*FunctionsAlphaVectorExpressionVectorFunctionInputValue) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorExpressionVectorFunctionInputValue) UnmarshalJSON(data []byte) error

func (FunctionsAlphaVectorExpressionVectorFunctionInputValue) Validate ¶ 

func (v FunctionsAlphaVectorExpressionVectorFunctionInputValue) Validate() error

type FunctionsAlphaVectorExpressionVectorFunctionInputValueExpression ¶ 

type FunctionsAlphaVectorExpressionVectorFunctionInputValueExpression struct {
	Context *FunctionsExpressionExpression `json:"context,omitempty"`
	Items   FunctionsExpressionExpression  `json:"items"`
}

func (FunctionsAlphaVectorExpressionVectorFunctionInputValueExpression) SchemaTitle ¶ 

func (FunctionsAlphaVectorExpressionVectorFunctionInputValueExpression) SchemaTitle() string

func (*FunctionsAlphaVectorExpressionVectorFunctionInputValueExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorExpressionVectorFunctionInputValueExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaVectorExpressionVectorFunctionInputValueExpression) Validate ¶ 

func (v FunctionsAlphaVectorExpressionVectorFunctionInputValueExpression) Validate() error

type FunctionsAlphaVectorInlineFunction ¶ 

type FunctionsAlphaVectorInlineFunction struct {
	Branch *FunctionsAlphaVectorInlineFunctionBranch
	Leaf   *FunctionsAlphaVectorInlineFunctionLeaf
}

func (FunctionsAlphaVectorInlineFunction) MarshalJSON ¶ 

func (v FunctionsAlphaVectorInlineFunction) MarshalJSON() ([]byte, error)

func (FunctionsAlphaVectorInlineFunction) SchemaTitle ¶ 

func (FunctionsAlphaVectorInlineFunction) SchemaTitle() string

func (*FunctionsAlphaVectorInlineFunction) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorInlineFunction) UnmarshalJSON(data []byte) error

func (FunctionsAlphaVectorInlineFunction) Validate ¶ 

func (v FunctionsAlphaVectorInlineFunction) Validate() error

type FunctionsAlphaVectorInlineFunctionBranch ¶ 

type FunctionsAlphaVectorInlineFunctionBranch struct {
	Tasks []FunctionsAlphaVectorBranchTaskExpression `json:"tasks"`
	Type  string                                     `json:"type" validate:"oneof=alpha.vector.branch.function"`
}

func (FunctionsAlphaVectorInlineFunctionBranch) SchemaVariantTitle ¶ 

func (FunctionsAlphaVectorInlineFunctionBranch) SchemaVariantTitle() string

func (*FunctionsAlphaVectorInlineFunctionBranch) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorInlineFunctionBranch) UnmarshalJSON(data []byte) error

type FunctionsAlphaVectorInlineFunctionLeaf ¶ 

type FunctionsAlphaVectorInlineFunctionLeaf struct {
	Tasks []FunctionsAlphaVectorLeafTaskExpression `json:"tasks"`
	Type  string                                   `json:"type" validate:"oneof=alpha.vector.leaf.function"`
}

func (FunctionsAlphaVectorInlineFunctionLeaf) SchemaVariantTitle ¶ 

func (FunctionsAlphaVectorInlineFunctionLeaf) SchemaVariantTitle() string

func (*FunctionsAlphaVectorInlineFunctionLeaf) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorInlineFunctionLeaf) UnmarshalJSON(data []byte) error

type FunctionsAlphaVectorLeafTaskExpression ¶ 

type FunctionsAlphaVectorLeafTaskExpression struct {
	FunctionsAlphaVectorVectorCompletionTaskExpression
	Type string `json:"type" validate:"oneof=vector.completion"`
}

func (FunctionsAlphaVectorLeafTaskExpression) MarshalJSON ¶ 

func (v FunctionsAlphaVectorLeafTaskExpression) MarshalJSON() ([]byte, error)

func (FunctionsAlphaVectorLeafTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaVectorLeafTaskExpression) SchemaTitle() string

func (*FunctionsAlphaVectorLeafTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorLeafTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaVectorLeafTaskExpression) Validate ¶ 

func (v FunctionsAlphaVectorLeafTaskExpression) Validate() error

type FunctionsAlphaVectorPartialPlaceholderBranchTaskExpression ¶ 

type FunctionsAlphaVectorPartialPlaceholderBranchTaskExpression struct {
	PlaceholderScalarFunction *FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderScalarFunction
	PlaceholderVectorFunction *FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderVectorFunction
}

func (FunctionsAlphaVectorPartialPlaceholderBranchTaskExpression) MarshalJSON ¶ 

func (v FunctionsAlphaVectorPartialPlaceholderBranchTaskExpression) MarshalJSON() ([]byte, error)

func (FunctionsAlphaVectorPartialPlaceholderBranchTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaVectorPartialPlaceholderBranchTaskExpression) SchemaTitle() string

func (*FunctionsAlphaVectorPartialPlaceholderBranchTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorPartialPlaceholderBranchTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaVectorPartialPlaceholderBranchTaskExpression) Validate ¶ 

func (v FunctionsAlphaVectorPartialPlaceholderBranchTaskExpression) Validate() error

type FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderScalarFunction ¶ 

type FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderScalarFunction struct {
	FunctionsAlphaVectorPartialPlaceholderScalarFunctionTaskExpression
	Type string `json:"type" validate:"oneof=placeholder.alpha.scalar.function"`
}

func (FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderScalarFunction) MarshalJSON ¶ 

func (v FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderScalarFunction) MarshalJSON() ([]byte, error)

func (FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderScalarFunction) SchemaVariantTitle ¶ 

func (FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderScalarFunction) SchemaVariantTitle() string

func (*FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderScalarFunction) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderScalarFunction) UnmarshalJSON(data []byte) error

type FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderVectorFunction ¶ 

type FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderVectorFunction struct {
	FunctionsAlphaVectorPartialPlaceholderVectorFunctionTaskExpression
	Type string `json:"type" validate:"oneof=placeholder.alpha.vector.function"`
}

func (FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderVectorFunction) MarshalJSON ¶ 

func (v FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderVectorFunction) MarshalJSON() ([]byte, error)

func (FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderVectorFunction) SchemaVariantTitle ¶ 

func (FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderVectorFunction) SchemaVariantTitle() string

func (*FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderVectorFunction) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorPartialPlaceholderBranchTaskExpressionPlaceholderVectorFunction) UnmarshalJSON(data []byte) error

type FunctionsAlphaVectorPartialPlaceholderScalarFunctionTaskExpression ¶ 

type FunctionsAlphaVectorPartialPlaceholderScalarFunctionTaskExpression struct {
	Input       FunctionsExpressionExpression        `json:"input"`
	InputSchema FunctionsExpressionObjectInputSchema `json:"input_schema"`
	Skip        *FunctionsExpressionExpression       `json:"skip,omitempty"`
	Spec        string                               `json:"spec"`
}

func (FunctionsAlphaVectorPartialPlaceholderScalarFunctionTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaVectorPartialPlaceholderScalarFunctionTaskExpression) SchemaTitle() string

func (*FunctionsAlphaVectorPartialPlaceholderScalarFunctionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorPartialPlaceholderScalarFunctionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaVectorPartialPlaceholderScalarFunctionTaskExpression) Validate ¶ 

func (v FunctionsAlphaVectorPartialPlaceholderScalarFunctionTaskExpression) Validate() error

type FunctionsAlphaVectorPartialPlaceholderVectorFunctionTaskExpression ¶ 

type FunctionsAlphaVectorPartialPlaceholderVectorFunctionTaskExpression struct {
	Input       FunctionsAlphaVectorExpressionVectorFunctionInputValueExpression `json:"input"`
	InputSchema FunctionsAlphaVectorExpressionVectorFunctionInputSchema          `json:"input_schema"`
	Skip        *FunctionsExpressionExpression                                   `json:"skip,omitempty"`
	Spec        string                                                           `json:"spec"`
}

func (FunctionsAlphaVectorPartialPlaceholderVectorFunctionTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaVectorPartialPlaceholderVectorFunctionTaskExpression) SchemaTitle() string

func (*FunctionsAlphaVectorPartialPlaceholderVectorFunctionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorPartialPlaceholderVectorFunctionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaVectorPartialPlaceholderVectorFunctionTaskExpression) Validate ¶ 

func (v FunctionsAlphaVectorPartialPlaceholderVectorFunctionTaskExpression) Validate() error

type FunctionsAlphaVectorPlaceholderScalarFunctionTaskExpression ¶ 

type FunctionsAlphaVectorPlaceholderScalarFunctionTaskExpression struct {
	Depth          uint64                               `json:"depth" validate:"min=0,max=18446744073709551615"`
	Input          FunctionsExpressionExpression        `json:"input"`
	InputSchema    FunctionsExpressionObjectInputSchema `json:"input_schema"`
	MaxBranchWidth uint64                               `json:"max_branch_width" validate:"min=0,max=18446744073709551615"`
	MaxLeafWidth   uint64                               `json:"max_leaf_width" validate:"min=0,max=18446744073709551615"`
	MinBranchWidth uint64                               `json:"min_branch_width" validate:"min=0,max=18446744073709551615"`
	MinLeafWidth   uint64                               `json:"min_leaf_width" validate:"min=0,max=18446744073709551615"`
	Name           string                               `json:"name"`
	Skip           *FunctionsExpressionExpression       `json:"skip,omitempty"`
	Spec           string                               `json:"spec"`
}

func (FunctionsAlphaVectorPlaceholderScalarFunctionTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaVectorPlaceholderScalarFunctionTaskExpression) SchemaTitle() string

func (*FunctionsAlphaVectorPlaceholderScalarFunctionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorPlaceholderScalarFunctionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaVectorPlaceholderScalarFunctionTaskExpression) Validate ¶ 

func (v FunctionsAlphaVectorPlaceholderScalarFunctionTaskExpression) Validate() error

type FunctionsAlphaVectorPlaceholderVectorFunctionTaskExpression ¶ 

type FunctionsAlphaVectorPlaceholderVectorFunctionTaskExpression struct {
	Depth          uint64                                                           `json:"depth" validate:"min=0,max=18446744073709551615"`
	Input          FunctionsAlphaVectorExpressionVectorFunctionInputValueExpression `json:"input"`
	InputSchema    FunctionsAlphaVectorExpressionVectorFunctionInputSchema          `json:"input_schema"`
	MaxBranchWidth uint64                                                           `json:"max_branch_width" validate:"min=0,max=18446744073709551615"`
	MaxLeafWidth   uint64                                                           `json:"max_leaf_width" validate:"min=0,max=18446744073709551615"`
	MinBranchWidth uint64                                                           `json:"min_branch_width" validate:"min=0,max=18446744073709551615"`
	MinLeafWidth   uint64                                                           `json:"min_leaf_width" validate:"min=0,max=18446744073709551615"`
	Name           string                                                           `json:"name"`
	Skip           *FunctionsExpressionExpression                                   `json:"skip,omitempty"`
	Spec           string                                                           `json:"spec"`
}

func (FunctionsAlphaVectorPlaceholderVectorFunctionTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaVectorPlaceholderVectorFunctionTaskExpression) SchemaTitle() string

func (*FunctionsAlphaVectorPlaceholderVectorFunctionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorPlaceholderVectorFunctionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaVectorPlaceholderVectorFunctionTaskExpression) Validate ¶ 

func (v FunctionsAlphaVectorPlaceholderVectorFunctionTaskExpression) Validate() error

type FunctionsAlphaVectorRemoteFunction ¶ 

type FunctionsAlphaVectorRemoteFunction struct {
	Branch *FunctionsAlphaVectorRemoteFunctionBranch
	Leaf   *FunctionsAlphaVectorRemoteFunctionLeaf
}

func (FunctionsAlphaVectorRemoteFunction) MarshalJSON ¶ 

func (v FunctionsAlphaVectorRemoteFunction) MarshalJSON() ([]byte, error)

func (FunctionsAlphaVectorRemoteFunction) SchemaTitle ¶ 

func (FunctionsAlphaVectorRemoteFunction) SchemaTitle() string

func (*FunctionsAlphaVectorRemoteFunction) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorRemoteFunction) UnmarshalJSON(data []byte) error

func (FunctionsAlphaVectorRemoteFunction) Validate ¶ 

func (v FunctionsAlphaVectorRemoteFunction) Validate() error

type FunctionsAlphaVectorRemoteFunctionBranch ¶ 

type FunctionsAlphaVectorRemoteFunctionBranch struct {
	Description string                                                  `json:"description"`
	InputSchema FunctionsAlphaVectorExpressionVectorFunctionInputSchema `json:"input_schema"`
	Tasks       []FunctionsAlphaVectorBranchTaskExpression              `json:"tasks"`
	Type        string                                                  `json:"type" validate:"oneof=alpha.vector.branch.function"`
}

func (FunctionsAlphaVectorRemoteFunctionBranch) SchemaVariantTitle ¶ 

func (FunctionsAlphaVectorRemoteFunctionBranch) SchemaVariantTitle() string

func (*FunctionsAlphaVectorRemoteFunctionBranch) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorRemoteFunctionBranch) UnmarshalJSON(data []byte) error

type FunctionsAlphaVectorRemoteFunctionLeaf ¶ 

type FunctionsAlphaVectorRemoteFunctionLeaf struct {
	Description string                                                  `json:"description"`
	InputSchema FunctionsAlphaVectorExpressionVectorFunctionInputSchema `json:"input_schema"`
	Tasks       []FunctionsAlphaVectorLeafTaskExpression                `json:"tasks"`
	Type        string                                                  `json:"type" validate:"oneof=alpha.vector.leaf.function"`
}

func (FunctionsAlphaVectorRemoteFunctionLeaf) SchemaVariantTitle ¶ 

func (FunctionsAlphaVectorRemoteFunctionLeaf) SchemaVariantTitle() string

func (*FunctionsAlphaVectorRemoteFunctionLeaf) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorRemoteFunctionLeaf) UnmarshalJSON(data []byte) error

type FunctionsAlphaVectorScalarFunctionTaskExpression ¶ 

type FunctionsAlphaVectorScalarFunctionTaskExpression struct {
	RemotePath
	Input FunctionsExpressionExpression  `json:"input"`
	Skip  *FunctionsExpressionExpression `json:"skip,omitempty"`
}

func (FunctionsAlphaVectorScalarFunctionTaskExpression) MarshalJSON ¶ 

func (v FunctionsAlphaVectorScalarFunctionTaskExpression) MarshalJSON() ([]byte, error)

func (FunctionsAlphaVectorScalarFunctionTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaVectorScalarFunctionTaskExpression) SchemaTitle() string

func (*FunctionsAlphaVectorScalarFunctionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorScalarFunctionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaVectorScalarFunctionTaskExpression) Validate ¶ 

func (v FunctionsAlphaVectorScalarFunctionTaskExpression) Validate() error

type FunctionsAlphaVectorVectorCompletionTaskExpression ¶ 

type FunctionsAlphaVectorVectorCompletionTaskExpression struct {
	Messages  FunctionsExpressionExpression  `json:"messages"`
	Responses FunctionsExpressionExpression  `json:"responses"`
	Skip      *FunctionsExpressionExpression `json:"skip,omitempty"`
}

func (FunctionsAlphaVectorVectorCompletionTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaVectorVectorCompletionTaskExpression) SchemaTitle() string

func (*FunctionsAlphaVectorVectorCompletionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorVectorCompletionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaVectorVectorCompletionTaskExpression) Validate ¶ 

func (v FunctionsAlphaVectorVectorCompletionTaskExpression) Validate() error

type FunctionsAlphaVectorVectorFunctionTaskExpression ¶ 

type FunctionsAlphaVectorVectorFunctionTaskExpression struct {
	RemotePath
	Input FunctionsAlphaVectorExpressionVectorFunctionInputValueExpression `json:"input"`
	Skip  *FunctionsExpressionExpression                                   `json:"skip,omitempty"`
}

func (FunctionsAlphaVectorVectorFunctionTaskExpression) MarshalJSON ¶ 

func (v FunctionsAlphaVectorVectorFunctionTaskExpression) MarshalJSON() ([]byte, error)

func (FunctionsAlphaVectorVectorFunctionTaskExpression) SchemaTitle ¶ 

func (FunctionsAlphaVectorVectorFunctionTaskExpression) SchemaTitle() string

func (*FunctionsAlphaVectorVectorFunctionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsAlphaVectorVectorFunctionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsAlphaVectorVectorFunctionTaskExpression) Validate ¶ 

func (v FunctionsAlphaVectorVectorFunctionTaskExpression) Validate() error

type FunctionsCheckScalarFieldsValidation ¶ 

type FunctionsCheckScalarFieldsValidation struct {
	InputSchema FunctionsExpressionInputSchema `json:"input_schema"`
}

The fields needed to validate a scalar function's input behavior.

func (FunctionsCheckScalarFieldsValidation) SchemaTitle ¶ 

func (FunctionsCheckScalarFieldsValidation) SchemaTitle() string

func (*FunctionsCheckScalarFieldsValidation) UnmarshalJSON ¶ 

func (v *FunctionsCheckScalarFieldsValidation) UnmarshalJSON(data []byte) error

func (FunctionsCheckScalarFieldsValidation) Validate ¶ 

func (v FunctionsCheckScalarFieldsValidation) Validate() error

type FunctionsCheckVectorFieldsValidation ¶ 

type FunctionsCheckVectorFieldsValidation struct {
	InputMerge   FunctionsExpressionExpression  `json:"input_merge"`
	InputSchema  FunctionsExpressionInputSchema `json:"input_schema"`
	InputSplit   FunctionsExpressionExpression  `json:"input_split"`
	OutputLength FunctionsExpressionExpression  `json:"output_length"`
}

The 4 fields needed to validate a vector function's split/merge behavior.

func (FunctionsCheckVectorFieldsValidation) SchemaTitle ¶ 

func (FunctionsCheckVectorFieldsValidation) SchemaTitle() string

func (*FunctionsCheckVectorFieldsValidation) UnmarshalJSON ¶ 

func (v *FunctionsCheckVectorFieldsValidation) UnmarshalJSON(data []byte) error

func (FunctionsCheckVectorFieldsValidation) Validate ¶ 

func (v FunctionsCheckVectorFieldsValidation) Validate() error

type FunctionsCompiledTask ¶ 

type FunctionsCompiledTask struct {
	// A single task (no mapping).
	One *FunctionsTask
	// Multiple task instances from mapped execution.
	Many *FunctionsCompiledTaskMany
}

The result of compiling a task expression.

Tasks without a `map` field compile to a single task. Tasks with a `map` expression are expanded into multiple tasks, one per integer index from 0 to the evaluated count.

func CompileFunctionTasks ¶ 

func CompileFunctionTasks(function FunctionsFunction, input FunctionsExpressionInputValue) ([]FunctionsCompiledTask, error)

CompileFunctionTasks compiles a Function's task expressions for a given input.

func (FunctionsCompiledTask) MarshalJSON ¶ 

func (v FunctionsCompiledTask) MarshalJSON() ([]byte, error)

func (FunctionsCompiledTask) SchemaTitle ¶ 

func (FunctionsCompiledTask) SchemaTitle() string

func (*FunctionsCompiledTask) UnmarshalJSON ¶ 

func (v *FunctionsCompiledTask) UnmarshalJSON(data []byte) error

func (FunctionsCompiledTask) Validate ¶ 

func (v FunctionsCompiledTask) Validate() error

type FunctionsCompiledTaskMany ¶ 

type FunctionsCompiledTaskMany []FunctionsTask

func (FunctionsCompiledTaskMany) SchemaVariantTitle ¶ 

func (FunctionsCompiledTaskMany) SchemaVariantTitle() string

type FunctionsExecutionsRequestFunctionExecutionCreateParams ¶ 

type FunctionsExecutionsRequestFunctionExecutionCreateParams struct {
	// Continuation from a previous completion, as a base64-encoded string.
	Continuation *string `json:"continuation,omitempty"`
	FromCache    *bool   `json:"from_cache,omitempty"`
	// The function to execute (inline definition or remote path).
	Function FunctionsFullInlineFunctionOrRemoteCommitOptional `json:"function"`
	Input    FunctionsExpressionInputValue                     `json:"input"`
	// If `true`, invert every output in the streamed response *after* the
	// inner function has finished computing — scalar outputs become
	// `1 - x`, vector outputs are reversed in place. The expression
	// evaluator inside the function still sees the original scores; only
	// the chunks delivered to the client (and the aggregated response
	// passed to the usage handler) are inverted. Useful when a function
	// is naturally written to score "lower is better" but the consumer
	// wants "higher is better", or vice versa.
	Invert *bool `json:"invert,omitempty"`
	// The profile to use (inline definition or remote path).
	Profile    FunctionsInlineProfileOrRemoteCommitOptional `json:"profile"`
	Provider   *AgentCompletionsRequestProvider             `json:"provider,omitempty"`
	Reasoning  *FunctionsExecutionsRequestReasoning         `json:"reasoning,omitempty"`
	RetryToken *string                                      `json:"retry_token,omitempty"`
	Seed       *int64                                       `json:"seed,omitempty" validate:"omitempty,min=-9223372036854775808,max=9223372036854775807"`
	Split      *bool                                        `json:"split,omitempty"`
	Strategy   *FunctionsExecutionsRequestStrategy          `json:"strategy,omitempty"`
	Stream     *bool                                        `json:"stream,omitempty"`
}

Parameters for creating a function execution.

func (FunctionsExecutionsRequestFunctionExecutionCreateParams) SchemaTitle ¶ 

func (FunctionsExecutionsRequestFunctionExecutionCreateParams) SchemaTitle() string

func (*FunctionsExecutionsRequestFunctionExecutionCreateParams) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsRequestFunctionExecutionCreateParams) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsRequestFunctionExecutionCreateParams) Validate ¶ 

func (v FunctionsExecutionsRequestFunctionExecutionCreateParams) Validate() error

type FunctionsExecutionsRequestReasoning ¶ 

type FunctionsExecutionsRequestReasoning struct {
	Agent AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional `json:"agent"`
}

func (FunctionsExecutionsRequestReasoning) SchemaTitle ¶ 

func (FunctionsExecutionsRequestReasoning) SchemaTitle() string

func (*FunctionsExecutionsRequestReasoning) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsRequestReasoning) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsRequestReasoning) Validate ¶ 

func (v FunctionsExecutionsRequestReasoning) Validate() error

type FunctionsExecutionsRequestStrategy ¶ 

type FunctionsExecutionsRequestStrategy struct {
	// Scalar or Vector
	Default *FunctionsExecutionsRequestStrategyDefault
	// Vector
	SwissSystem *FunctionsExecutionsRequestStrategySwissSystem
}

func (FunctionsExecutionsRequestStrategy) MarshalJSON ¶ 

func (v FunctionsExecutionsRequestStrategy) MarshalJSON() ([]byte, error)

func (FunctionsExecutionsRequestStrategy) SchemaTitle ¶ 

func (FunctionsExecutionsRequestStrategy) SchemaTitle() string

func (*FunctionsExecutionsRequestStrategy) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsRequestStrategy) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsRequestStrategy) Validate ¶ 

func (v FunctionsExecutionsRequestStrategy) Validate() error

type FunctionsExecutionsRequestStrategyDefault ¶ 

type FunctionsExecutionsRequestStrategyDefault struct {
	Type string `json:"type" validate:"oneof=default"`
}

Scalar or Vector

func (FunctionsExecutionsRequestStrategyDefault) SchemaVariantTitle ¶ 

func (FunctionsExecutionsRequestStrategyDefault) SchemaVariantTitle() string

func (*FunctionsExecutionsRequestStrategyDefault) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsRequestStrategyDefault) UnmarshalJSON(data []byte) error

type FunctionsExecutionsRequestStrategySwissSystem ¶ 

type FunctionsExecutionsRequestStrategySwissSystem struct {
	// How many vector responses for each execution
	Pool *uint32 `json:"pool" validate:"omitempty,min=0,max=4294967295"`
	// How many sequential rounds of comparison
	Rounds *uint32 `json:"rounds" validate:"omitempty,min=0,max=4294967295"`
	Type   string  `json:"type" validate:"oneof=swiss_system"`
}

Vector

func (FunctionsExecutionsRequestStrategySwissSystem) SchemaVariantTitle ¶ 

func (FunctionsExecutionsRequestStrategySwissSystem) SchemaVariantTitle() string

func (*FunctionsExecutionsRequestStrategySwissSystem) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsRequestStrategySwissSystem) UnmarshalJSON(data []byte) error

type FunctionsExecutionsResponseOutput ¶ 

type FunctionsExecutionsResponseOutput struct {
	Output FunctionsExpressionTaskOutput `json:"output"`
}

Wrapper for function execution output, distinguishing between a null output value and a missing output.

func (FunctionsExecutionsResponseOutput) SchemaTitle ¶ 

func (FunctionsExecutionsResponseOutput) SchemaTitle() string

func (*FunctionsExecutionsResponseOutput) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsResponseOutput) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsResponseOutput) Validate ¶ 

func (v FunctionsExecutionsResponseOutput) Validate() error

type FunctionsExecutionsResponseStreamingFunctionExecutionChunk ¶ 

type FunctionsExecutionsResponseStreamingFunctionExecutionChunk struct {
	Created     uint64                                                     `json:"created" validate:"min=0,max=18446744073709551615"`
	Error       *ErrorResponseError                                        `json:"error,omitempty"`
	Function    *RemotePath                                                `json:"function"`
	ID          string                                                     `json:"id"`
	Object      FunctionsExecutionsResponseStreamingObject                 `json:"object"`
	Output      *FunctionsExecutionsResponseOutput                         `json:"output,omitempty"`
	Profile     *RemotePath                                                `json:"profile"`
	Reasoning   *FunctionsExecutionsResponseStreamingReasoningSummaryChunk `json:"reasoning,omitempty"`
	RetryToken  *string                                                    `json:"retry_token,omitempty"`
	Tasks       []FunctionsExecutionsResponseStreamingTaskChunk            `json:"tasks"`
	TasksErrors *bool                                                      `json:"tasks_errors,omitempty"`
	Usage       *AgentCompletionsResponseUsage                             `json:"usage,omitempty"`
}

func FunctionExecutionChunkMerged ¶ 

func FunctionExecutionChunkMerged(a, b FunctionsExecutionsResponseStreamingFunctionExecutionChunk) (*FunctionsExecutionsResponseStreamingFunctionExecutionChunk, error)

FunctionExecutionChunkMerged merges two FunctionExecutionChunks via push.

func FunctionExecutionChunkNormalized ¶ 

func FunctionExecutionChunkNormalized(chunk FunctionsExecutionsResponseStreamingFunctionExecutionChunk) (*FunctionsExecutionsResponseStreamingFunctionExecutionChunk, error)

FunctionExecutionChunkNormalized normalizes a FunctionExecutionChunk.

func GenerateFunctionExecutionChunk ¶ 

func GenerateFunctionExecutionChunk(hasSeed bool, seed int64) (*FunctionsExecutionsResponseStreamingFunctionExecutionChunk, error)

GenerateFunctionExecutionChunk generates a random FunctionExecutionChunk from a seed.

func (*FunctionsExecutionsResponseStreamingFunctionExecutionChunk) Push ¶ 

func (v *FunctionsExecutionsResponseStreamingFunctionExecutionChunk) Push(other *FunctionsExecutionsResponseStreamingFunctionExecutionChunk)

Push accumulates another FunctionExecutionChunk into this one.

func (FunctionsExecutionsResponseStreamingFunctionExecutionChunk) SchemaTitle ¶ 

func (FunctionsExecutionsResponseStreamingFunctionExecutionChunk) SchemaTitle() string

func (*FunctionsExecutionsResponseStreamingFunctionExecutionChunk) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsResponseStreamingFunctionExecutionChunk) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsResponseStreamingFunctionExecutionChunk) Validate ¶ 

func (v FunctionsExecutionsResponseStreamingFunctionExecutionChunk) Validate() error

type FunctionsExecutionsResponseStreamingFunctionExecutionTaskChunk ¶ 

type FunctionsExecutionsResponseStreamingFunctionExecutionTaskChunk struct {
	Created        uint64                                                     `json:"created" validate:"min=0,max=18446744073709551615"`
	Error          *ErrorResponseError                                        `json:"error,omitempty"`
	Function       *RemotePath                                                `json:"function"`
	ID             string                                                     `json:"id"`
	Index          uint64                                                     `json:"index" validate:"min=0,max=18446744073709551615"`
	Object         FunctionsExecutionsResponseStreamingObject                 `json:"object"`
	Output         *FunctionsExecutionsResponseOutput                         `json:"output,omitempty"`
	Profile        *RemotePath                                                `json:"profile"`
	Reasoning      *FunctionsExecutionsResponseStreamingReasoningSummaryChunk `json:"reasoning,omitempty"`
	RetryToken     *string                                                    `json:"retry_token,omitempty"`
	SplitIndex     *uint64                                                    `json:"split_index,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	SwissPoolIndex *uint64                                                    `json:"swiss_pool_index,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	SwissRound     *uint64                                                    `json:"swiss_round,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	TaskIndex      uint64                                                     `json:"task_index" validate:"min=0,max=18446744073709551615"`
	TaskPath       []uint64                                                   `json:"task_path" validate:"dive,min=0,max=18446744073709551615"`
	Tasks          []FunctionsExecutionsResponseStreamingTaskChunk            `json:"tasks"`
	TasksErrors    *bool                                                      `json:"tasks_errors,omitempty"`
	Usage          *AgentCompletionsResponseUsage                             `json:"usage,omitempty"`
}

func (*FunctionsExecutionsResponseStreamingFunctionExecutionTaskChunk) Push ¶ 

func (v *FunctionsExecutionsResponseStreamingFunctionExecutionTaskChunk) Push(other *FunctionsExecutionsResponseStreamingFunctionExecutionTaskChunk)

Push accumulates another FunctionExecutionTaskChunk into this one.

func (FunctionsExecutionsResponseStreamingFunctionExecutionTaskChunk) SchemaTitle ¶ 

func (FunctionsExecutionsResponseStreamingFunctionExecutionTaskChunk) SchemaTitle() string

func (*FunctionsExecutionsResponseStreamingFunctionExecutionTaskChunk) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsResponseStreamingFunctionExecutionTaskChunk) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsResponseStreamingFunctionExecutionTaskChunk) Validate ¶ 

func (v FunctionsExecutionsResponseStreamingFunctionExecutionTaskChunk) Validate() error

type FunctionsExecutionsResponseStreamingObject ¶ 

type FunctionsExecutionsResponseStreamingObject struct {
	ScalarFunctionExecutionChunk *string `validate:"omitempty,oneof=scalar.function.execution.chunk"`
	VectorFunctionExecutionChunk *string `validate:"omitempty,oneof=vector.function.execution.chunk"`
}

func (FunctionsExecutionsResponseStreamingObject) MarshalJSON ¶ 

func (v FunctionsExecutionsResponseStreamingObject) MarshalJSON() ([]byte, error)

func (FunctionsExecutionsResponseStreamingObject) SchemaTitle ¶ 

func (FunctionsExecutionsResponseStreamingObject) SchemaTitle() string

func (*FunctionsExecutionsResponseStreamingObject) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsResponseStreamingObject) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsResponseStreamingObject) Validate ¶ 

func (v FunctionsExecutionsResponseStreamingObject) Validate() error

type FunctionsExecutionsResponseStreamingReasoningSummaryChunk ¶ 

type FunctionsExecutionsResponseStreamingReasoningSummaryChunk struct {
	// Continuation state for multi-turn conversations (only present in the final chunk).
	Continuation *string                                         `json:"continuation,omitempty"`
	Created      uint64                                          `json:"created" validate:"min=0,max=18446744073709551615"`
	Error        *ErrorResponseError                             `json:"error,omitempty"`
	ID           string                                          `json:"id"`
	Messages     []AgentCompletionsResponseStreamingMessageChunk `json:"messages"`
	// The object type (always "agent.completion.chunk").
	Object AgentCompletionsResponseStreamingObject `json:"object"`
	// Upstream provider
	Upstream AgentUpstream `json:"upstream"`
	// Token usage (only present in the final chunk).
	Usage *AgentCompletionsResponseUsage `json:"usage,omitempty"`
}

A chunk of a streaming agent completion response.

Multiple chunks are received via Server-Sent Events and can be accumulated into a complete [`AgentCompletion`](response::unary::AgentCompletion) using the [`push`](Self::push) method.

func (*FunctionsExecutionsResponseStreamingReasoningSummaryChunk) Push ¶ 

func (v *FunctionsExecutionsResponseStreamingReasoningSummaryChunk) Push(other *FunctionsExecutionsResponseStreamingReasoningSummaryChunk)

Push accumulates another ReasoningSummaryChunk into this one.

func (FunctionsExecutionsResponseStreamingReasoningSummaryChunk) SchemaTitle ¶ 

func (FunctionsExecutionsResponseStreamingReasoningSummaryChunk) SchemaTitle() string

func (*FunctionsExecutionsResponseStreamingReasoningSummaryChunk) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsResponseStreamingReasoningSummaryChunk) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsResponseStreamingReasoningSummaryChunk) Validate ¶ 

func (v FunctionsExecutionsResponseStreamingReasoningSummaryChunk) Validate() error

type FunctionsExecutionsResponseStreamingTaskChunk ¶ 

type FunctionsExecutionsResponseStreamingTaskChunk struct {
	FunctionExecution *FunctionsExecutionsResponseStreamingFunctionExecutionTaskChunk
	VectorCompletion  *FunctionsExecutionsResponseStreamingVectorCompletionTaskChunk
}

func (*FunctionsExecutionsResponseStreamingTaskChunk) Index ¶ 

func (v *FunctionsExecutionsResponseStreamingTaskChunk) Index() *uint64

Index returns the index from whichever variant is set.

func (FunctionsExecutionsResponseStreamingTaskChunk) MarshalJSON ¶ 

func (v FunctionsExecutionsResponseStreamingTaskChunk) MarshalJSON() ([]byte, error)

func (*FunctionsExecutionsResponseStreamingTaskChunk) Push ¶ 

func (v *FunctionsExecutionsResponseStreamingTaskChunk) Push(other *FunctionsExecutionsResponseStreamingTaskChunk)

Push accumulates another TaskChunk into this one. Variant dispatch: only merges if both are the same variant type.

func (FunctionsExecutionsResponseStreamingTaskChunk) SchemaTitle ¶ 

func (FunctionsExecutionsResponseStreamingTaskChunk) SchemaTitle() string

func (*FunctionsExecutionsResponseStreamingTaskChunk) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsResponseStreamingTaskChunk) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsResponseStreamingTaskChunk) Validate ¶ 

func (v FunctionsExecutionsResponseStreamingTaskChunk) Validate() error

type FunctionsExecutionsResponseStreamingVectorCompletionTaskChunk ¶ 

type FunctionsExecutionsResponseStreamingVectorCompletionTaskChunk struct {
	// Incremental agent completion chunks from each agent.
	Completions []VectorCompletionsResponseStreamingAgentCompletionChunk `json:"completions"`
	// Unix timestamp when the completion was created.
	Created uint64              `json:"created" validate:"min=0,max=18446744073709551615"`
	Error   *ErrorResponseError `json:"error,omitempty"`
	// Unique identifier for this vector completion.
	ID    string `json:"id"`
	Index uint64 `json:"index" validate:"min=0,max=18446744073709551615"`
	// Object type identifier (`"vector.completion.chunk"`).
	Object VectorCompletionsResponseStreamingObject `json:"object"`
	// Current weighted scores. Updated as new votes arrive.
	Scores []float64 `json:"scores" validate:"dive,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// ID of the swarm used for this completion.
	Swarm     string   `json:"swarm"`
	TaskIndex uint64   `json:"task_index" validate:"min=0,max=18446744073709551615"`
	TaskPath  []uint64 `json:"task_path" validate:"dive,min=0,max=18446744073709551615"`
	// Aggregated usage statistics. Typically present only in the final chunk.
	Usage *AgentCompletionsResponseUsage `json:"usage,omitempty"`
	// Votes received so far. New votes are appended in subsequent chunks.
	Votes []VectorCompletionsResponseVote `json:"votes"`
	// Current weight distribution across responses. Updated as new votes arrive.
	Weights []float64 `json:"weights" validate:"dive,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

A chunk in a streaming vector completion response.

Each chunk contains incremental updates to the completion. Use the [`push`](Self::push) method to accumulate chunks into a complete response.

func (*FunctionsExecutionsResponseStreamingVectorCompletionTaskChunk) Push ¶ 

func (v *FunctionsExecutionsResponseStreamingVectorCompletionTaskChunk) Push(other *FunctionsExecutionsResponseStreamingVectorCompletionTaskChunk)

Push accumulates another VectorCompletionTaskChunk into this one.

func (FunctionsExecutionsResponseStreamingVectorCompletionTaskChunk) SchemaTitle ¶ 

func (FunctionsExecutionsResponseStreamingVectorCompletionTaskChunk) SchemaTitle() string

func (*FunctionsExecutionsResponseStreamingVectorCompletionTaskChunk) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsResponseStreamingVectorCompletionTaskChunk) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsResponseStreamingVectorCompletionTaskChunk) Validate ¶ 

func (v FunctionsExecutionsResponseStreamingVectorCompletionTaskChunk) Validate() error

type FunctionsExecutionsResponseUnaryFunctionExecution ¶ 

type FunctionsExecutionsResponseUnaryFunctionExecution struct {
	// Unix timestamp when the execution was created.
	Created uint64 `json:"created" validate:"min=0,max=18446744073709551615"`
	// Error details if the execution failed.
	Error *ErrorResponseError `json:"error"`
	// The function used (if remote).
	Function *RemotePath `json:"function"`
	// Unique identifier for this execution.
	ID string `json:"id"`
	// Object type identifier.
	Object FunctionsExecutionsResponseUnaryObject `json:"object"`
	// The final output (scalar or vector score).
	Output FunctionsExecutionsResponseOutput `json:"output"`
	// The profile used (if remote).
	Profile *RemotePath `json:"profile"`
	// Reasoning summary if reasoning was enabled.
	Reasoning *FunctionsExecutionsResponseUnaryReasoningSummary `json:"reasoning"`
	// Token for retrying this execution with cached votes.
	RetryToken *string `json:"retry_token"`
	// Results from each task in the function.
	Tasks []FunctionsExecutionsResponseUnaryTask `json:"tasks"`
	// Whether any tasks encountered errors.
	TasksErrors bool `json:"tasks_errors"`
	// Aggregated token and cost usage.
	Usage AgentCompletionsResponseUsage `json:"usage"`
}

A complete function execution response (non-streaming).

func FunctionExecutionChunkToUnary ¶ 

func FunctionExecutionChunkToUnary(chunk FunctionsExecutionsResponseStreamingFunctionExecutionChunk) (*FunctionsExecutionsResponseUnaryFunctionExecution, error)

FunctionExecutionChunkToUnary converts an accumulated chunk to a unary FunctionExecution.

func FunctionsExecutionsCreateFunctionExecutionUnary ¶ 

func FunctionsExecutionsCreateFunctionExecutionUnary(ctx context.Context, c *Client, params FunctionsExecutionsRequestFunctionExecutionCreateParams) (*FunctionsExecutionsResponseUnaryFunctionExecution, error)

func NormalizeFunctionExecutionForTests ¶ 

func NormalizeFunctionExecutionForTests(v FunctionsExecutionsResponseUnaryFunctionExecution) (*FunctionsExecutionsResponseUnaryFunctionExecution, error)

NormalizeFunctionExecutionForTests normalizes a FunctionExecution by round-tripping through serde.

func (FunctionsExecutionsResponseUnaryFunctionExecution) SchemaTitle ¶ 

func (FunctionsExecutionsResponseUnaryFunctionExecution) SchemaTitle() string

func (*FunctionsExecutionsResponseUnaryFunctionExecution) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsResponseUnaryFunctionExecution) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsResponseUnaryFunctionExecution) Validate ¶ 

func (v FunctionsExecutionsResponseUnaryFunctionExecution) Validate() error

type FunctionsExecutionsResponseUnaryFunctionExecutionTask ¶ 

type FunctionsExecutionsResponseUnaryFunctionExecutionTask struct {
	// Unix timestamp when the execution was created.
	Created uint64 `json:"created" validate:"min=0,max=18446744073709551615"`
	// Error details if the execution failed.
	Error *ErrorResponseError `json:"error"`
	// The function used (if remote).
	Function *RemotePath `json:"function"`
	// Unique identifier for this execution.
	ID    string `json:"id"`
	Index uint64 `json:"index" validate:"min=0,max=18446744073709551615"`
	// Object type identifier.
	Object FunctionsExecutionsResponseUnaryObject `json:"object"`
	// The final output (scalar or vector score).
	Output FunctionsExecutionsResponseOutput `json:"output"`
	// The profile used (if remote).
	Profile *RemotePath `json:"profile"`
	// Reasoning summary if reasoning was enabled.
	Reasoning *FunctionsExecutionsResponseUnaryReasoningSummary `json:"reasoning"`
	// Token for retrying this execution with cached votes.
	RetryToken     *string  `json:"retry_token"`
	SplitIndex     *uint64  `json:"split_index,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	SwissPoolIndex *uint64  `json:"swiss_pool_index,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	SwissRound     *uint64  `json:"swiss_round,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	TaskIndex      uint64   `json:"task_index" validate:"min=0,max=18446744073709551615"`
	TaskPath       []uint64 `json:"task_path" validate:"dive,min=0,max=18446744073709551615"`
	// Results from each task in the function.
	Tasks []FunctionsExecutionsResponseUnaryTask `json:"tasks"`
	// Whether any tasks encountered errors.
	TasksErrors bool `json:"tasks_errors"`
	// Aggregated token and cost usage.
	Usage AgentCompletionsResponseUsage `json:"usage"`
}

A complete function execution response (non-streaming).

func (FunctionsExecutionsResponseUnaryFunctionExecutionTask) SchemaTitle ¶ 

func (FunctionsExecutionsResponseUnaryFunctionExecutionTask) SchemaTitle() string

func (*FunctionsExecutionsResponseUnaryFunctionExecutionTask) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsResponseUnaryFunctionExecutionTask) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsResponseUnaryFunctionExecutionTask) Validate ¶ 

func (v FunctionsExecutionsResponseUnaryFunctionExecutionTask) Validate() error

type FunctionsExecutionsResponseUnaryObject ¶ 

type FunctionsExecutionsResponseUnaryObject struct {
	ScalarFunctionExecution *string `validate:"omitempty,oneof=scalar.function.execution"`
	VectorFunctionExecution *string `validate:"omitempty,oneof=vector.function.execution"`
}

func (FunctionsExecutionsResponseUnaryObject) MarshalJSON ¶ 

func (v FunctionsExecutionsResponseUnaryObject) MarshalJSON() ([]byte, error)

func (FunctionsExecutionsResponseUnaryObject) SchemaTitle ¶ 

func (FunctionsExecutionsResponseUnaryObject) SchemaTitle() string

func (*FunctionsExecutionsResponseUnaryObject) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsResponseUnaryObject) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsResponseUnaryObject) Validate ¶ 

func (v FunctionsExecutionsResponseUnaryObject) Validate() error

type FunctionsExecutionsResponseUnaryReasoningSummary ¶ 

type FunctionsExecutionsResponseUnaryReasoningSummary struct {
	// Continuation state for multi-turn conversations.
	Continuation *string                                `json:"continuation"`
	Created      uint64                                 `json:"created" validate:"min=0,max=18446744073709551615"`
	Error        *ErrorResponseError                    `json:"error"`
	ID           string                                 `json:"id"`
	Messages     []AgentCompletionsResponseUnaryMessage `json:"messages"`
	// The object type (always "agent.completion").
	Object AgentCompletionsResponseUnaryObject `json:"object"`
	// Upstream provider
	Upstream AgentUpstream                 `json:"upstream"`
	Usage    AgentCompletionsResponseUsage `json:"usage"`
}

A complete agent completion response.

func (FunctionsExecutionsResponseUnaryReasoningSummary) SchemaTitle ¶ 

func (FunctionsExecutionsResponseUnaryReasoningSummary) SchemaTitle() string

func (*FunctionsExecutionsResponseUnaryReasoningSummary) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsResponseUnaryReasoningSummary) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsResponseUnaryReasoningSummary) Validate ¶ 

func (v FunctionsExecutionsResponseUnaryReasoningSummary) Validate() error

type FunctionsExecutionsResponseUnaryTask ¶ 

type FunctionsExecutionsResponseUnaryTask struct {
	FunctionExecution *FunctionsExecutionsResponseUnaryFunctionExecutionTask
	VectorCompletion  *FunctionsExecutionsResponseUnaryVectorCompletionTask
}

func (FunctionsExecutionsResponseUnaryTask) MarshalJSON ¶ 

func (v FunctionsExecutionsResponseUnaryTask) MarshalJSON() ([]byte, error)

func (FunctionsExecutionsResponseUnaryTask) SchemaTitle ¶ 

func (FunctionsExecutionsResponseUnaryTask) SchemaTitle() string

func (*FunctionsExecutionsResponseUnaryTask) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsResponseUnaryTask) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsResponseUnaryTask) Validate ¶ 

func (v FunctionsExecutionsResponseUnaryTask) Validate() error

type FunctionsExecutionsResponseUnaryVectorCompletionTask ¶ 

type FunctionsExecutionsResponseUnaryVectorCompletionTask struct {
	// The underlying agent completions from each agent in the swarm.
	Completions []VectorCompletionsResponseUnaryAgentCompletion `json:"completions"`
	// Unix timestamp when the completion was created.
	Created uint64              `json:"created" validate:"min=0,max=18446744073709551615"`
	Error   *ErrorResponseError `json:"error"`
	// Unique identifier for this vector completion.
	ID    string `json:"id"`
	Index uint64 `json:"index" validate:"min=0,max=18446744073709551615"`
	// Object type identifier (`"vector.completion"`).
	Object VectorCompletionsResponseUnaryObject `json:"object"`
	// Final weighted scores for each response option. Sums to 1.
	Scores []float64 `json:"scores" validate:"dive,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// ID of the swarm used for this completion.
	Swarm     string   `json:"swarm"`
	TaskIndex uint64   `json:"task_index" validate:"min=0,max=18446744073709551615"`
	TaskPath  []uint64 `json:"task_path" validate:"dive,min=0,max=18446744073709551615"`
	// Aggregated token and cost usage across all completions.
	Usage AgentCompletionsResponseUsage `json:"usage"`
	// Individual votes from each agent, showing their selections.
	Votes []VectorCompletionsResponseVote `json:"votes"`
	// Total weight allocated to each response option. Same length as `scores`.
	// For discrete votes, an LLM's full weight goes to its selected response.
	// For probabilistic votes, the weight is divided according to the distribution.
	Weights []float64 `json:"weights" validate:"dive,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

A complete vector completion response (non-streaming).

Contains the final scores, all votes from the swarm, and the underlying agent completions that produced those votes.

func (FunctionsExecutionsResponseUnaryVectorCompletionTask) SchemaTitle ¶ 

func (FunctionsExecutionsResponseUnaryVectorCompletionTask) SchemaTitle() string

func (*FunctionsExecutionsResponseUnaryVectorCompletionTask) UnmarshalJSON ¶ 

func (v *FunctionsExecutionsResponseUnaryVectorCompletionTask) UnmarshalJSON(data []byte) error

func (FunctionsExecutionsResponseUnaryVectorCompletionTask) Validate ¶ 

func (v FunctionsExecutionsResponseUnaryVectorCompletionTask) Validate() error

type FunctionsExecutionsRetryToken ¶ 

type FunctionsExecutionsRetryToken []*string

Token that enables reusing votes from a previous function execution.

Contains identifiers for each task's votes that can be reused in a subsequent execution. Serialized as base64-encoded JSON.

func (FunctionsExecutionsRetryToken) SchemaTitle ¶ 

func (FunctionsExecutionsRetryToken) SchemaTitle() string

type FunctionsExpressionAnyOfInputSchema ¶ 

type FunctionsExpressionAnyOfInputSchema struct {
	// The possible schemas that the input can match.
	AnyOf []FunctionsExpressionInputSchema `json:"anyOf"`
}

Schema for a union of possible types - input must match at least one.

func (FunctionsExpressionAnyOfInputSchema) SchemaTitle ¶ 

func (FunctionsExpressionAnyOfInputSchema) SchemaTitle() string

func (*FunctionsExpressionAnyOfInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsExpressionAnyOfInputSchema) UnmarshalJSON(data []byte) error

func (FunctionsExpressionAnyOfInputSchema) Validate ¶ 

func (v FunctionsExpressionAnyOfInputSchema) Validate() error

type FunctionsExpressionArrayInputSchema ¶ 

type FunctionsExpressionArrayInputSchema struct {
	// Human-readable description of the array.
	Description *string `json:"description,omitempty"`
	// Schema for each item in the array.
	Items FunctionsExpressionInputSchema `json:"items"`
	// Maximum number of items allowed.
	MaxItems *uint64 `json:"maxItems,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	// Minimum number of items required.
	MinItems *uint64                                 `json:"minItems,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	Type     FunctionsExpressionArrayInputSchemaType `json:"type"`
}

Schema for an array input.

func (FunctionsExpressionArrayInputSchema) SchemaTitle ¶ 

func (FunctionsExpressionArrayInputSchema) SchemaTitle() string

func (*FunctionsExpressionArrayInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsExpressionArrayInputSchema) UnmarshalJSON(data []byte) error

func (FunctionsExpressionArrayInputSchema) Validate ¶ 

func (v FunctionsExpressionArrayInputSchema) Validate() error

type FunctionsExpressionArrayInputSchemaType ¶ 

type FunctionsExpressionArrayInputSchemaType struct {
	Array string `validate:"omitempty,oneof=array"`
}

func (FunctionsExpressionArrayInputSchemaType) MarshalJSON ¶ 

func (v FunctionsExpressionArrayInputSchemaType) MarshalJSON() ([]byte, error)

func (FunctionsExpressionArrayInputSchemaType) SchemaTitle ¶ 

func (FunctionsExpressionArrayInputSchemaType) SchemaTitle() string

func (*FunctionsExpressionArrayInputSchemaType) UnmarshalJSON ¶ 

func (v *FunctionsExpressionArrayInputSchemaType) UnmarshalJSON(data []byte) error

func (FunctionsExpressionArrayInputSchemaType) Validate ¶ 

func (v FunctionsExpressionArrayInputSchemaType) Validate() error

type FunctionsExpressionAudioInputSchema ¶ 

type FunctionsExpressionAudioInputSchema struct {
	// Human-readable description of the expected audio.
	Description *string                                 `json:"description,omitempty"`
	Type        FunctionsExpressionAudioInputSchemaType `json:"type"`
}

Schema for an audio input.

func (FunctionsExpressionAudioInputSchema) SchemaTitle ¶ 

func (FunctionsExpressionAudioInputSchema) SchemaTitle() string

func (*FunctionsExpressionAudioInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsExpressionAudioInputSchema) UnmarshalJSON(data []byte) error

func (FunctionsExpressionAudioInputSchema) Validate ¶ 

func (v FunctionsExpressionAudioInputSchema) Validate() error

type FunctionsExpressionAudioInputSchemaType ¶ 

type FunctionsExpressionAudioInputSchemaType struct {
	Audio string `validate:"omitempty,oneof=audio"`
}

func (FunctionsExpressionAudioInputSchemaType) MarshalJSON ¶ 

func (v FunctionsExpressionAudioInputSchemaType) MarshalJSON() ([]byte, error)

func (FunctionsExpressionAudioInputSchemaType) SchemaTitle ¶ 

func (FunctionsExpressionAudioInputSchemaType) SchemaTitle() string

func (*FunctionsExpressionAudioInputSchemaType) UnmarshalJSON ¶ 

func (v *FunctionsExpressionAudioInputSchemaType) UnmarshalJSON(data []byte) error

func (FunctionsExpressionAudioInputSchemaType) Validate ¶ 

func (v FunctionsExpressionAudioInputSchemaType) Validate() error

type FunctionsExpressionBooleanInputSchema ¶ 

type FunctionsExpressionBooleanInputSchema struct {
	// Human-readable description of the boolean.
	Description *string                                   `json:"description,omitempty"`
	Type        FunctionsExpressionBooleanInputSchemaType `json:"type"`
}

Schema for a boolean input.

func (FunctionsExpressionBooleanInputSchema) SchemaTitle ¶ 

func (FunctionsExpressionBooleanInputSchema) SchemaTitle() string

func (*FunctionsExpressionBooleanInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsExpressionBooleanInputSchema) UnmarshalJSON(data []byte) error

func (FunctionsExpressionBooleanInputSchema) Validate ¶ 

func (v FunctionsExpressionBooleanInputSchema) Validate() error

type FunctionsExpressionBooleanInputSchemaType ¶ 

type FunctionsExpressionBooleanInputSchemaType struct {
	Boolean string `validate:"omitempty,oneof=boolean"`
}

func (FunctionsExpressionBooleanInputSchemaType) MarshalJSON ¶ 

func (v FunctionsExpressionBooleanInputSchemaType) MarshalJSON() ([]byte, error)

func (FunctionsExpressionBooleanInputSchemaType) SchemaTitle ¶ 

func (FunctionsExpressionBooleanInputSchemaType) SchemaTitle() string

func (*FunctionsExpressionBooleanInputSchemaType) UnmarshalJSON ¶ 

func (v *FunctionsExpressionBooleanInputSchemaType) UnmarshalJSON(data []byte) error

func (FunctionsExpressionBooleanInputSchemaType) Validate ¶ 

func (v FunctionsExpressionBooleanInputSchemaType) Validate() error

type FunctionsExpressionExpression ¶ 

type FunctionsExpressionExpression struct {
	// A JMESPath expression.
	JMESPath *FunctionsExpressionExpressionJMESPath
	// A Starlark expression.
	Starlark *FunctionsExpressionExpressionStarlark
	// A predefined special expression variant.
	Special *FunctionsExpressionExpressionSpecial
}

An expression that can be either JMESPath or Starlark.

Serializes as `{"$jmespath": "..."}` or `{"$starlark": "..."}` in JSON.

Examples ¶

JMESPath: ```json {"$jmespath": "input.items[0].name"} ```

Starlark: ```json {"$starlark": "input['items'][0]['name']"} ```

func (FunctionsExpressionExpression) MarshalJSON ¶ 

func (v FunctionsExpressionExpression) MarshalJSON() ([]byte, error)

func (FunctionsExpressionExpression) SchemaTitle ¶ 

func (FunctionsExpressionExpression) SchemaTitle() string

func (*FunctionsExpressionExpression) UnmarshalJSON ¶ 

func (v *FunctionsExpressionExpression) UnmarshalJSON(data []byte) error

func (FunctionsExpressionExpression) Validate ¶ 

func (v FunctionsExpressionExpression) Validate() error

type FunctionsExpressionExpressionJMESPath ¶ 

type FunctionsExpressionExpressionJMESPath struct {
	Jmespath string `json:"$jmespath"`
}

A JMESPath expression.

func (FunctionsExpressionExpressionJMESPath) AdditionalProperties ¶ 

func (FunctionsExpressionExpressionJMESPath) AdditionalProperties() bool

func (FunctionsExpressionExpressionJMESPath) SchemaVariantTitle ¶ 

func (FunctionsExpressionExpressionJMESPath) SchemaVariantTitle() string

func (*FunctionsExpressionExpressionJMESPath) UnmarshalJSON ¶ 

func (v *FunctionsExpressionExpressionJMESPath) UnmarshalJSON(data []byte) error

type FunctionsExpressionExpressionSpecial ¶ 

type FunctionsExpressionExpressionSpecial struct {
	Special FunctionsExpressionSpecial `json:"$special"`
}

A predefined special expression variant.

func (FunctionsExpressionExpressionSpecial) AdditionalProperties ¶ 

func (FunctionsExpressionExpressionSpecial) AdditionalProperties() bool

func (FunctionsExpressionExpressionSpecial) SchemaVariantTitle ¶ 

func (FunctionsExpressionExpressionSpecial) SchemaVariantTitle() string

func (*FunctionsExpressionExpressionSpecial) UnmarshalJSON ¶ 

func (v *FunctionsExpressionExpressionSpecial) UnmarshalJSON(data []byte) error

type FunctionsExpressionExpressionStarlark ¶ 

type FunctionsExpressionExpressionStarlark struct {
	Starlark string `json:"$starlark"`
}

A Starlark expression.

func (FunctionsExpressionExpressionStarlark) AdditionalProperties ¶ 

func (FunctionsExpressionExpressionStarlark) AdditionalProperties() bool

func (FunctionsExpressionExpressionStarlark) SchemaVariantTitle ¶ 

func (FunctionsExpressionExpressionStarlark) SchemaVariantTitle() string

func (*FunctionsExpressionExpressionStarlark) UnmarshalJSON ¶ 

func (v *FunctionsExpressionExpressionStarlark) UnmarshalJSON(data []byte) error

type FunctionsExpressionFileInputSchema ¶ 

type FunctionsExpressionFileInputSchema struct {
	// Human-readable description of the expected file.
	Description *string                                `json:"description,omitempty"`
	Type        FunctionsExpressionFileInputSchemaType `json:"type"`
}

Schema for a file input.

func (FunctionsExpressionFileInputSchema) SchemaTitle ¶ 

func (FunctionsExpressionFileInputSchema) SchemaTitle() string

func (*FunctionsExpressionFileInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsExpressionFileInputSchema) UnmarshalJSON(data []byte) error

func (FunctionsExpressionFileInputSchema) Validate ¶ 

func (v FunctionsExpressionFileInputSchema) Validate() error

type FunctionsExpressionFileInputSchemaType ¶ 

type FunctionsExpressionFileInputSchemaType struct {
	File string `validate:"omitempty,oneof=file"`
}

func (FunctionsExpressionFileInputSchemaType) MarshalJSON ¶ 

func (v FunctionsExpressionFileInputSchemaType) MarshalJSON() ([]byte, error)

func (FunctionsExpressionFileInputSchemaType) SchemaTitle ¶ 

func (FunctionsExpressionFileInputSchemaType) SchemaTitle() string

func (*FunctionsExpressionFileInputSchemaType) UnmarshalJSON ¶ 

func (v *FunctionsExpressionFileInputSchemaType) UnmarshalJSON(data []byte) error

func (FunctionsExpressionFileInputSchemaType) Validate ¶ 

func (v FunctionsExpressionFileInputSchemaType) Validate() error

type FunctionsExpressionImageInputSchema ¶ 

type FunctionsExpressionImageInputSchema struct {
	// Human-readable description of the expected image.
	Description *string                                 `json:"description,omitempty"`
	Type        FunctionsExpressionImageInputSchemaType `json:"type"`
}

Schema for an image input (URL or base64-encoded).

func (FunctionsExpressionImageInputSchema) SchemaTitle ¶ 

func (FunctionsExpressionImageInputSchema) SchemaTitle() string

func (*FunctionsExpressionImageInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsExpressionImageInputSchema) UnmarshalJSON(data []byte) error

func (FunctionsExpressionImageInputSchema) Validate ¶ 

func (v FunctionsExpressionImageInputSchema) Validate() error

type FunctionsExpressionImageInputSchemaType ¶ 

type FunctionsExpressionImageInputSchemaType struct {
	Image string `validate:"omitempty,oneof=image"`
}

func (FunctionsExpressionImageInputSchemaType) MarshalJSON ¶ 

func (v FunctionsExpressionImageInputSchemaType) MarshalJSON() ([]byte, error)

func (FunctionsExpressionImageInputSchemaType) SchemaTitle ¶ 

func (FunctionsExpressionImageInputSchemaType) SchemaTitle() string

func (*FunctionsExpressionImageInputSchemaType) UnmarshalJSON ¶ 

func (v *FunctionsExpressionImageInputSchemaType) UnmarshalJSON(data []byte) error

func (FunctionsExpressionImageInputSchemaType) Validate ¶ 

func (v FunctionsExpressionImageInputSchemaType) Validate() error

type FunctionsExpressionInputSchema ¶ 

type FunctionsExpressionInputSchema struct {
	// A union of schemas - input must match at least one.
	AnyOf *FunctionsExpressionAnyOfInputSchema
	// An object with named properties.
	Object *FunctionsExpressionObjectInputSchema
	// An array of items.
	Array *FunctionsExpressionArrayInputSchema
	// A string value.
	String *FunctionsExpressionStringInputSchema
	// An integer value.
	Integer *FunctionsExpressionIntegerInputSchema
	// A floating-point number.
	Number *FunctionsExpressionNumberInputSchema
	// A boolean value.
	Boolean *FunctionsExpressionBooleanInputSchema
	// An image (URL or base64).
	Image *FunctionsExpressionImageInputSchema
	// Audio content.
	Audio *FunctionsExpressionAudioInputSchema
	// Video content.
	Video *FunctionsExpressionVideoInputSchema
	// A file.
	File *FunctionsExpressionFileInputSchema
}

Schema for validating Function input.

Defines the expected structure and constraints for input data. Used by remote Functions to document and validate their inputs.

func (FunctionsExpressionInputSchema) MarshalJSON ¶ 

func (v FunctionsExpressionInputSchema) MarshalJSON() ([]byte, error)

func (FunctionsExpressionInputSchema) SchemaTitle ¶ 

func (FunctionsExpressionInputSchema) SchemaTitle() string

func (*FunctionsExpressionInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsExpressionInputSchema) UnmarshalJSON(data []byte) error

func (FunctionsExpressionInputSchema) Validate ¶ 

func (v FunctionsExpressionInputSchema) Validate() error

type FunctionsExpressionInputValue ¶ 

type FunctionsExpressionInputValue struct {
	// Rich content (image, audio, video, file).
	RichContentPart *AgentCompletionsMessageRichContentPart
	// An object with string keys.
	Object *FunctionsExpressionInputValueObject
	// An array of values.
	Array *FunctionsExpressionInputValueArray
	// A string value.
	String *FunctionsExpressionInputValueString
	// An integer value.
	Integer *FunctionsExpressionInputValueInteger `validate:"omitempty,min=-9223372036854775808,max=9223372036854775807"`
	// A floating-point number.
	Number *FunctionsExpressionInputValueNumber `validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// A boolean value.
	Boolean *FunctionsExpressionInputValueBoolean
}

A concrete input value (post-compilation).

Represents any JSON-like value that can be passed to a Function, including rich content types (images, audio, video, files).

func CompileFunctionInputMerge ¶ 

func CompileFunctionInputMerge(function FunctionsFunction, input []FunctionsExpressionInputValue) (*FunctionsExpressionInputValue, error)

CompileFunctionInputMerge compiles the input_merge expression.

func CompileFunctionInputSplit ¶ 

func CompileFunctionInputSplit(function FunctionsFunction, input FunctionsExpressionInputValue) ([]FunctionsExpressionInputValue, error)

CompileFunctionInputSplit compiles the input_split expression.

func (FunctionsExpressionInputValue) MarshalJSON ¶ 

func (v FunctionsExpressionInputValue) MarshalJSON() ([]byte, error)

func (FunctionsExpressionInputValue) SchemaTitle ¶ 

func (FunctionsExpressionInputValue) SchemaTitle() string

func (*FunctionsExpressionInputValue) UnmarshalJSON ¶ 

func (v *FunctionsExpressionInputValue) UnmarshalJSON(data []byte) error

func (FunctionsExpressionInputValue) Validate ¶ 

func (v FunctionsExpressionInputValue) Validate() error

type FunctionsExpressionInputValueArray ¶ 

type FunctionsExpressionInputValueArray []FunctionsExpressionInputValue

func (FunctionsExpressionInputValueArray) SchemaVariantTitle ¶ 

func (FunctionsExpressionInputValueArray) SchemaVariantTitle() string

type FunctionsExpressionInputValueBoolean ¶ 

type FunctionsExpressionInputValueBoolean bool

func (FunctionsExpressionInputValueBoolean) SchemaVariantTitle ¶ 

func (FunctionsExpressionInputValueBoolean) SchemaVariantTitle() string

type FunctionsExpressionInputValueExpression ¶ 

type FunctionsExpressionInputValueExpression struct {
	// Rich content (image, audio, video, file).
	RichContentPart *AgentCompletionsMessageRichContentPart
	// An object with values that may be expressions.
	Object *FunctionsExpressionInputValueExpressionObject
	// An array with elements that may be expressions.
	Array *FunctionsExpressionInputValueExpressionArray
	// A string value.
	String *FunctionsExpressionInputValueExpressionString
	// An integer value.
	Integer *FunctionsExpressionInputValueExpressionInteger `validate:"omitempty,min=-9223372036854775808,max=9223372036854775807"`
	// A floating-point number.
	Number *FunctionsExpressionInputValueExpressionNumber `validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// A boolean value.
	Boolean *FunctionsExpressionInputValueExpressionBoolean
}

An input value that may contain expressions (pre-compilation).

Similar to [`InputValue`] but object values and array elements can be expressions (JMESPath or Starlark) that are evaluated during compilation.

func (FunctionsExpressionInputValueExpression) MarshalJSON ¶ 

func (v FunctionsExpressionInputValueExpression) MarshalJSON() ([]byte, error)

func (FunctionsExpressionInputValueExpression) SchemaTitle ¶ 

func (FunctionsExpressionInputValueExpression) SchemaTitle() string

func (*FunctionsExpressionInputValueExpression) UnmarshalJSON ¶ 

func (v *FunctionsExpressionInputValueExpression) UnmarshalJSON(data []byte) error

func (FunctionsExpressionInputValueExpression) Validate ¶ 

func (v FunctionsExpressionInputValueExpression) Validate() error

type FunctionsExpressionInputValueExpressionArray ¶ 

type FunctionsExpressionInputValueExpressionArray []FunctionsExpressionInputValueExpressionArrayItem

func (FunctionsExpressionInputValueExpressionArray) SchemaVariantTitle ¶ 

func (FunctionsExpressionInputValueExpressionArray) SchemaVariantTitle() string

type FunctionsExpressionInputValueExpressionArrayItem ¶ 

type FunctionsExpressionInputValueExpressionArrayItem struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *FunctionsExpressionInputValueExpression
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (FunctionsExpressionInputValueExpressionArrayItem) MarshalJSON ¶ 

func (v FunctionsExpressionInputValueExpressionArrayItem) MarshalJSON() ([]byte, error)

func (*FunctionsExpressionInputValueExpressionArrayItem) UnmarshalJSON ¶ 

func (v *FunctionsExpressionInputValueExpressionArrayItem) UnmarshalJSON(data []byte) error

func (FunctionsExpressionInputValueExpressionArrayItem) Validate ¶ 

func (v FunctionsExpressionInputValueExpressionArrayItem) Validate() error

type FunctionsExpressionInputValueExpressionBoolean ¶ 

type FunctionsExpressionInputValueExpressionBoolean bool

func (FunctionsExpressionInputValueExpressionBoolean) SchemaVariantTitle ¶ 

func (FunctionsExpressionInputValueExpressionBoolean) SchemaVariantTitle() string

type FunctionsExpressionInputValueExpressionInteger ¶ 

type FunctionsExpressionInputValueExpressionInteger int64

func (FunctionsExpressionInputValueExpressionInteger) SchemaVariantTitle ¶ 

func (FunctionsExpressionInputValueExpressionInteger) SchemaVariantTitle() string

type FunctionsExpressionInputValueExpressionNumber ¶ 

type FunctionsExpressionInputValueExpressionNumber float64

func (FunctionsExpressionInputValueExpressionNumber) SchemaVariantTitle ¶ 

func (FunctionsExpressionInputValueExpressionNumber) SchemaVariantTitle() string

type FunctionsExpressionInputValueExpressionObject ¶ 

type FunctionsExpressionInputValueExpressionObject OrderedMap[string, FunctionsExpressionInputValueExpressionObjectValue]

func NewFunctionsExpressionInputValueExpressionObject ¶ 

func NewFunctionsExpressionInputValueExpressionObject(pairs ...orderedmap.Pair[string, FunctionsExpressionInputValueExpressionObjectValue]) FunctionsExpressionInputValueExpressionObject

func (FunctionsExpressionInputValueExpressionObject) MarshalJSON ¶ 

func (v FunctionsExpressionInputValueExpressionObject) MarshalJSON() ([]byte, error)

func (FunctionsExpressionInputValueExpressionObject) SchemaVariantTitle ¶ 

func (FunctionsExpressionInputValueExpressionObject) SchemaVariantTitle() string

func (*FunctionsExpressionInputValueExpressionObject) UnmarshalJSON ¶ 

func (v *FunctionsExpressionInputValueExpressionObject) UnmarshalJSON(data []byte) error

type FunctionsExpressionInputValueExpressionObjectValue ¶ 

type FunctionsExpressionInputValueExpressionObjectValue struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *FunctionsExpressionInputValueExpression
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (FunctionsExpressionInputValueExpressionObjectValue) MarshalJSON ¶ 

func (v FunctionsExpressionInputValueExpressionObjectValue) MarshalJSON() ([]byte, error)

func (*FunctionsExpressionInputValueExpressionObjectValue) UnmarshalJSON ¶ 

func (v *FunctionsExpressionInputValueExpressionObjectValue) UnmarshalJSON(data []byte) error

func (FunctionsExpressionInputValueExpressionObjectValue) Validate ¶ 

func (v FunctionsExpressionInputValueExpressionObjectValue) Validate() error

type FunctionsExpressionInputValueExpressionString ¶ 

type FunctionsExpressionInputValueExpressionString string

func (FunctionsExpressionInputValueExpressionString) SchemaVariantTitle ¶ 

func (FunctionsExpressionInputValueExpressionString) SchemaVariantTitle() string

type FunctionsExpressionInputValueInteger ¶ 

type FunctionsExpressionInputValueInteger int64

func (FunctionsExpressionInputValueInteger) SchemaVariantTitle ¶ 

func (FunctionsExpressionInputValueInteger) SchemaVariantTitle() string

type FunctionsExpressionInputValueNumber ¶ 

type FunctionsExpressionInputValueNumber float64

func (FunctionsExpressionInputValueNumber) SchemaVariantTitle ¶ 

func (FunctionsExpressionInputValueNumber) SchemaVariantTitle() string

type FunctionsExpressionInputValueObject ¶ 

type FunctionsExpressionInputValueObject OrderedMap[string, FunctionsExpressionInputValue]

func NewFunctionsExpressionInputValueObject ¶ 

func NewFunctionsExpressionInputValueObject(pairs ...orderedmap.Pair[string, FunctionsExpressionInputValue]) FunctionsExpressionInputValueObject

func (FunctionsExpressionInputValueObject) MarshalJSON ¶ 

func (v FunctionsExpressionInputValueObject) MarshalJSON() ([]byte, error)

func (FunctionsExpressionInputValueObject) SchemaVariantTitle ¶ 

func (FunctionsExpressionInputValueObject) SchemaVariantTitle() string

func (*FunctionsExpressionInputValueObject) UnmarshalJSON ¶ 

func (v *FunctionsExpressionInputValueObject) UnmarshalJSON(data []byte) error

type FunctionsExpressionInputValueString ¶ 

type FunctionsExpressionInputValueString string

func (FunctionsExpressionInputValueString) SchemaVariantTitle ¶ 

func (FunctionsExpressionInputValueString) SchemaVariantTitle() string

type FunctionsExpressionIntegerInputSchema ¶ 

type FunctionsExpressionIntegerInputSchema struct {
	// Human-readable description of the integer.
	Description *string `json:"description,omitempty"`
	// Maximum allowed value (inclusive).
	Maximum *int64 `json:"maximum,omitempty" validate:"omitempty,min=-9223372036854775808,max=9223372036854775807"`
	// Minimum allowed value (inclusive).
	Minimum *int64                                    `json:"minimum,omitempty" validate:"omitempty,min=-9223372036854775808,max=9223372036854775807"`
	Type    FunctionsExpressionIntegerInputSchemaType `json:"type"`
}

Schema for an integer input.

func (FunctionsExpressionIntegerInputSchema) SchemaTitle ¶ 

func (FunctionsExpressionIntegerInputSchema) SchemaTitle() string

func (*FunctionsExpressionIntegerInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsExpressionIntegerInputSchema) UnmarshalJSON(data []byte) error

func (FunctionsExpressionIntegerInputSchema) Validate ¶ 

func (v FunctionsExpressionIntegerInputSchema) Validate() error

type FunctionsExpressionIntegerInputSchemaType ¶ 

type FunctionsExpressionIntegerInputSchemaType struct {
	Integer string `validate:"omitempty,oneof=integer"`
}

func (FunctionsExpressionIntegerInputSchemaType) MarshalJSON ¶ 

func (v FunctionsExpressionIntegerInputSchemaType) MarshalJSON() ([]byte, error)

func (FunctionsExpressionIntegerInputSchemaType) SchemaTitle ¶ 

func (FunctionsExpressionIntegerInputSchemaType) SchemaTitle() string

func (*FunctionsExpressionIntegerInputSchemaType) UnmarshalJSON ¶ 

func (v *FunctionsExpressionIntegerInputSchemaType) UnmarshalJSON(data []byte) error

func (FunctionsExpressionIntegerInputSchemaType) Validate ¶ 

func (v FunctionsExpressionIntegerInputSchemaType) Validate() error

type FunctionsExpressionNumberInputSchema ¶ 

type FunctionsExpressionNumberInputSchema struct {
	// Human-readable description of the number.
	Description *string `json:"description,omitempty"`
	// Maximum allowed value (inclusive).
	Maximum *float64 `json:"maximum,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Minimum allowed value (inclusive).
	Minimum *float64                                 `json:"minimum,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	Type    FunctionsExpressionNumberInputSchemaType `json:"type"`
}

Schema for a floating-point number input.

func (FunctionsExpressionNumberInputSchema) SchemaTitle ¶ 

func (FunctionsExpressionNumberInputSchema) SchemaTitle() string

func (*FunctionsExpressionNumberInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsExpressionNumberInputSchema) UnmarshalJSON(data []byte) error

func (FunctionsExpressionNumberInputSchema) Validate ¶ 

func (v FunctionsExpressionNumberInputSchema) Validate() error

type FunctionsExpressionNumberInputSchemaType ¶ 

type FunctionsExpressionNumberInputSchemaType struct {
	Number string `validate:"omitempty,oneof=number"`
}

func (FunctionsExpressionNumberInputSchemaType) MarshalJSON ¶ 

func (v FunctionsExpressionNumberInputSchemaType) MarshalJSON() ([]byte, error)

func (FunctionsExpressionNumberInputSchemaType) SchemaTitle ¶ 

func (FunctionsExpressionNumberInputSchemaType) SchemaTitle() string

func (*FunctionsExpressionNumberInputSchemaType) UnmarshalJSON ¶ 

func (v *FunctionsExpressionNumberInputSchemaType) UnmarshalJSON(data []byte) error

func (FunctionsExpressionNumberInputSchemaType) Validate ¶ 

func (v FunctionsExpressionNumberInputSchemaType) Validate() error

type FunctionsExpressionObjectInputSchema ¶ 

type FunctionsExpressionObjectInputSchema struct {
	// Human-readable description of the object.
	Description *string `json:"description,omitempty"`
	// Schema for each property in the object.
	Properties OrderedMap[string, FunctionsExpressionInputSchema] `json:"properties"`
	// List of property names that must be present.
	Required *[]string                                `json:"required,omitempty"`
	Type     FunctionsExpressionObjectInputSchemaType `json:"type"`
}

Schema for an object input with named properties.

func (FunctionsExpressionObjectInputSchema) SchemaTitle ¶ 

func (FunctionsExpressionObjectInputSchema) SchemaTitle() string

func (*FunctionsExpressionObjectInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsExpressionObjectInputSchema) UnmarshalJSON(data []byte) error

func (FunctionsExpressionObjectInputSchema) Validate ¶ 

func (v FunctionsExpressionObjectInputSchema) Validate() error

type FunctionsExpressionObjectInputSchemaType ¶ 

type FunctionsExpressionObjectInputSchemaType struct {
	Object string `validate:"omitempty,oneof=object"`
}

func (FunctionsExpressionObjectInputSchemaType) MarshalJSON ¶ 

func (v FunctionsExpressionObjectInputSchemaType) MarshalJSON() ([]byte, error)

func (FunctionsExpressionObjectInputSchemaType) SchemaTitle ¶ 

func (FunctionsExpressionObjectInputSchemaType) SchemaTitle() string

func (*FunctionsExpressionObjectInputSchemaType) UnmarshalJSON ¶ 

func (v *FunctionsExpressionObjectInputSchemaType) UnmarshalJSON(data []byte) error

func (FunctionsExpressionObjectInputSchemaType) Validate ¶ 

func (v FunctionsExpressionObjectInputSchemaType) Validate() error

type FunctionsExpressionParams ¶ 

type FunctionsExpressionParams struct {
	// Current recursion depth.
	// Only provided for invention prompt expressions.
	Depth *uint64 `json:"depth" validate:"omitempty,min=0,max=18446744073709551615"`
	// The function's input data.
	Input FunctionsExpressionInputValue `json:"input"`
	// Current map index. Only populated for mapped task expressions.
	Map *uint64 `json:"map" validate:"omitempty,min=0,max=18446744073709551615"`
	// The function's name.
	// Only provided for invention prompt expressions.
	Name *string `json:"name"`
	// Results from executed tasks. Only populated for task output expressions.
	Output *FunctionsExpressionTaskOutput `json:"output"`
	// The specification text.
	// Only provided for invention prompt expressions.
	Spec *string `json:"spec"`
	// Resolved maximum task count for this node type.
	// Only provided for invention prompt expressions.
	TasksMax *uint64 `json:"tasks_max" validate:"omitempty,min=0,max=18446744073709551615"`
	// Resolved minimum task count for this node type.
	// Only provided for invention prompt expressions.
	TasksMin *uint64 `json:"tasks_min" validate:"omitempty,min=0,max=18446744073709551615"`
}

Owned version of expression parameters.

func (FunctionsExpressionParams) SchemaTitle ¶ 

func (FunctionsExpressionParams) SchemaTitle() string

func (*FunctionsExpressionParams) UnmarshalJSON ¶ 

func (v *FunctionsExpressionParams) UnmarshalJSON(data []byte) error

func (FunctionsExpressionParams) Validate ¶ 

func (v FunctionsExpressionParams) Validate() error

type FunctionsExpressionSpecial ¶ 

type FunctionsExpressionSpecial struct {
	// Returns the params input as-is.
	Input *FunctionsExpressionSpecialInput `validate:"omitempty,oneof=input"`
	// Returns the params output as-is.
	Output *FunctionsExpressionSpecialOutput `validate:"omitempty,oneof=output"`
	// L1-normalizes the output. Scalar/Err pass through.
	// Vector: L1 normalize. Vectors: L1 normalize each.
	TaskOutputL1Normalized *FunctionsExpressionSpecialTaskOutputL1Normalized `validate:"omitempty,oneof=task_output_l1_normalized"`
	// Weighted sum of the output. Vector → Scalar. Vectors → Vector.
	TaskOutputWeightedSum *FunctionsExpressionSpecialTaskOutputWeightedSum `validate:"omitempty,oneof=task_output_weighted_sum"`
	// Returns the length of input['items'] as u64
	InputItemsOutputLength *FunctionsExpressionSpecialInputItemsOutputLength `validate:"omitempty,oneof=input_items_output_length"`
	// Splits an input containing items and optionally context into multiple inputs
	InputItemsOptionalContextSplit *FunctionsExpressionSpecialInputItemsOptionalContextSplit `validate:"omitempty,oneof=input_items_optional_context_split"`
	// Merges multiple inputs containing items and optionally context into a single input
	InputItemsOptionalContextMerge *FunctionsExpressionSpecialInputItemsOptionalContextMerge `validate:"omitempty,oneof=input_items_optional_context_merge"`
}

Predefined expression behaviors that require no user-authored code.

func (FunctionsExpressionSpecial) MarshalJSON ¶ 

func (v FunctionsExpressionSpecial) MarshalJSON() ([]byte, error)

func (FunctionsExpressionSpecial) SchemaTitle ¶ 

func (FunctionsExpressionSpecial) SchemaTitle() string

func (*FunctionsExpressionSpecial) UnmarshalJSON ¶ 

func (v *FunctionsExpressionSpecial) UnmarshalJSON(data []byte) error

func (FunctionsExpressionSpecial) Validate ¶ 

func (v FunctionsExpressionSpecial) Validate() error

type FunctionsExpressionSpecialInput ¶ 

type FunctionsExpressionSpecialInput string

func (FunctionsExpressionSpecialInput) SchemaVariantTitle ¶ 

func (FunctionsExpressionSpecialInput) SchemaVariantTitle() string

type FunctionsExpressionSpecialInputItemsOptionalContextMerge ¶ 

type FunctionsExpressionSpecialInputItemsOptionalContextMerge string

func (FunctionsExpressionSpecialInputItemsOptionalContextMerge) SchemaVariantTitle ¶ 

func (FunctionsExpressionSpecialInputItemsOptionalContextMerge) SchemaVariantTitle() string

type FunctionsExpressionSpecialInputItemsOptionalContextSplit ¶ 

type FunctionsExpressionSpecialInputItemsOptionalContextSplit string

func (FunctionsExpressionSpecialInputItemsOptionalContextSplit) SchemaVariantTitle ¶ 

func (FunctionsExpressionSpecialInputItemsOptionalContextSplit) SchemaVariantTitle() string

type FunctionsExpressionSpecialInputItemsOutputLength ¶ 

type FunctionsExpressionSpecialInputItemsOutputLength string

func (FunctionsExpressionSpecialInputItemsOutputLength) SchemaVariantTitle ¶ 

func (FunctionsExpressionSpecialInputItemsOutputLength) SchemaVariantTitle() string

type FunctionsExpressionSpecialOutput ¶ 

type FunctionsExpressionSpecialOutput string

func (FunctionsExpressionSpecialOutput) SchemaVariantTitle ¶ 

func (FunctionsExpressionSpecialOutput) SchemaVariantTitle() string

type FunctionsExpressionSpecialTaskOutputL1Normalized ¶ 

type FunctionsExpressionSpecialTaskOutputL1Normalized string

func (FunctionsExpressionSpecialTaskOutputL1Normalized) SchemaVariantTitle ¶ 

func (FunctionsExpressionSpecialTaskOutputL1Normalized) SchemaVariantTitle() string

type FunctionsExpressionSpecialTaskOutputWeightedSum ¶ 

type FunctionsExpressionSpecialTaskOutputWeightedSum string

func (FunctionsExpressionSpecialTaskOutputWeightedSum) SchemaVariantTitle ¶ 

func (FunctionsExpressionSpecialTaskOutputWeightedSum) SchemaVariantTitle() string

type FunctionsExpressionStringInputSchema ¶ 

type FunctionsExpressionStringInputSchema struct {
	// Human-readable description of the string.
	Description *string `json:"description,omitempty"`
	// If provided, the string must be one of these values.
	Enum *[]string                                `json:"enum,omitempty"`
	Type FunctionsExpressionStringInputSchemaType `json:"type"`
}

Schema for a string input.

func (FunctionsExpressionStringInputSchema) SchemaTitle ¶ 

func (FunctionsExpressionStringInputSchema) SchemaTitle() string

func (*FunctionsExpressionStringInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsExpressionStringInputSchema) UnmarshalJSON(data []byte) error

func (FunctionsExpressionStringInputSchema) Validate ¶ 

func (v FunctionsExpressionStringInputSchema) Validate() error

type FunctionsExpressionStringInputSchemaType ¶ 

type FunctionsExpressionStringInputSchemaType struct {
	String string `validate:"omitempty,oneof=string"`
}

func (FunctionsExpressionStringInputSchemaType) MarshalJSON ¶ 

func (v FunctionsExpressionStringInputSchemaType) MarshalJSON() ([]byte, error)

func (FunctionsExpressionStringInputSchemaType) SchemaTitle ¶ 

func (FunctionsExpressionStringInputSchemaType) SchemaTitle() string

func (*FunctionsExpressionStringInputSchemaType) UnmarshalJSON ¶ 

func (v *FunctionsExpressionStringInputSchemaType) UnmarshalJSON(data []byte) error

func (FunctionsExpressionStringInputSchemaType) Validate ¶ 

func (v FunctionsExpressionStringInputSchemaType) Validate() error

type FunctionsExpressionTaskOutput ¶ 

type FunctionsExpressionTaskOutput struct {
	// A single scalar score.
	Scalar *FunctionsExpressionTaskOutputScalar `validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// A vector of scores.
	Vector *FunctionsExpressionTaskOutputVector `validate:"omitempty,dive,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Multiple vectors of scores (from mapped tasks).
	Vectors *FunctionsExpressionTaskOutputVectors `validate:"omitempty,dive,dive,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// An error occurred during execution.
	Err *FunctionsExpressionTaskOutputErr
}

Owned task output variants.

func (FunctionsExpressionTaskOutput) MarshalJSON ¶ 

func (v FunctionsExpressionTaskOutput) MarshalJSON() ([]byte, error)

func (FunctionsExpressionTaskOutput) SchemaTitle ¶ 

func (FunctionsExpressionTaskOutput) SchemaTitle() string

func (*FunctionsExpressionTaskOutput) UnmarshalJSON ¶ 

func (v *FunctionsExpressionTaskOutput) UnmarshalJSON(data []byte) error

func (FunctionsExpressionTaskOutput) Validate ¶ 

func (v FunctionsExpressionTaskOutput) Validate() error

type FunctionsExpressionTaskOutputErr ¶ 

type FunctionsExpressionTaskOutputErr struct {
	Error JsonValue `json:"error"`
}

An error occurred during execution.

func (FunctionsExpressionTaskOutputErr) SchemaVariantTitle ¶ 

func (FunctionsExpressionTaskOutputErr) SchemaVariantTitle() string

func (*FunctionsExpressionTaskOutputErr) UnmarshalJSON ¶ 

func (v *FunctionsExpressionTaskOutputErr) UnmarshalJSON(data []byte) error

type FunctionsExpressionTaskOutputScalar ¶ 

type FunctionsExpressionTaskOutputScalar float64

func (FunctionsExpressionTaskOutputScalar) SchemaVariantTitle ¶ 

func (FunctionsExpressionTaskOutputScalar) SchemaVariantTitle() string

type FunctionsExpressionTaskOutputVector ¶ 

type FunctionsExpressionTaskOutputVector []float64

func (FunctionsExpressionTaskOutputVector) SchemaVariantTitle ¶ 

func (FunctionsExpressionTaskOutputVector) SchemaVariantTitle() string

type FunctionsExpressionTaskOutputVectors ¶ 

type FunctionsExpressionTaskOutputVectors [][]float64

func (FunctionsExpressionTaskOutputVectors) SchemaVariantTitle ¶ 

func (FunctionsExpressionTaskOutputVectors) SchemaVariantTitle() string

type FunctionsExpressionVideoInputSchema ¶ 

type FunctionsExpressionVideoInputSchema struct {
	// Human-readable description of the expected video.
	Description *string                                 `json:"description,omitempty"`
	Type        FunctionsExpressionVideoInputSchemaType `json:"type"`
}

Schema for a video input (URL or base64-encoded).

func (FunctionsExpressionVideoInputSchema) SchemaTitle ¶ 

func (FunctionsExpressionVideoInputSchema) SchemaTitle() string

func (*FunctionsExpressionVideoInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsExpressionVideoInputSchema) UnmarshalJSON(data []byte) error

func (FunctionsExpressionVideoInputSchema) Validate ¶ 

func (v FunctionsExpressionVideoInputSchema) Validate() error

type FunctionsExpressionVideoInputSchemaType ¶ 

type FunctionsExpressionVideoInputSchemaType struct {
	Video string `validate:"omitempty,oneof=video"`
}

func (FunctionsExpressionVideoInputSchemaType) MarshalJSON ¶ 

func (v FunctionsExpressionVideoInputSchemaType) MarshalJSON() ([]byte, error)

func (FunctionsExpressionVideoInputSchemaType) SchemaTitle ¶ 

func (FunctionsExpressionVideoInputSchemaType) SchemaTitle() string

func (*FunctionsExpressionVideoInputSchemaType) UnmarshalJSON ¶ 

func (v *FunctionsExpressionVideoInputSchemaType) UnmarshalJSON(data []byte) error

func (FunctionsExpressionVideoInputSchemaType) Validate ¶ 

func (v FunctionsExpressionVideoInputSchemaType) Validate() error

type FunctionsFullFunction ¶ 

type FunctionsFullFunction struct {
	Remote *FunctionsFullRemoteFunction
	Inline *FunctionsFullInlineFunction
}

A full function, either remote or inline.

func (FunctionsFullFunction) MarshalJSON ¶ 

func (v FunctionsFullFunction) MarshalJSON() ([]byte, error)

func (FunctionsFullFunction) SchemaTitle ¶ 

func (FunctionsFullFunction) SchemaTitle() string

func (*FunctionsFullFunction) UnmarshalJSON ¶ 

func (v *FunctionsFullFunction) UnmarshalJSON(data []byte) error

func (FunctionsFullFunction) Validate ¶ 

func (v FunctionsFullFunction) Validate() error

type FunctionsFullInlineFunction ¶ 

type FunctionsFullInlineFunction struct {
	Alpha    *FunctionsAlphaInlineFunction
	Standard *FunctionsInlineFunction
}

func (FunctionsFullInlineFunction) MarshalJSON ¶ 

func (v FunctionsFullInlineFunction) MarshalJSON() ([]byte, error)

func (FunctionsFullInlineFunction) SchemaTitle ¶ 

func (FunctionsFullInlineFunction) SchemaTitle() string

func (*FunctionsFullInlineFunction) UnmarshalJSON ¶ 

func (v *FunctionsFullInlineFunction) UnmarshalJSON(data []byte) error

func (FunctionsFullInlineFunction) Validate ¶ 

func (v FunctionsFullInlineFunction) Validate() error

type FunctionsFullInlineFunctionOrRemoteCommitOptional ¶ 

type FunctionsFullInlineFunctionOrRemoteCommitOptional struct {
	Inline *FunctionsFullInlineFunction
	Remote *RemotePathCommitOptional
}

A function specification that is either a full inline function definition or a remote path reference.

func (FunctionsFullInlineFunctionOrRemoteCommitOptional) MarshalJSON ¶ 

func (v FunctionsFullInlineFunctionOrRemoteCommitOptional) MarshalJSON() ([]byte, error)

func (FunctionsFullInlineFunctionOrRemoteCommitOptional) SchemaTitle ¶ 

func (FunctionsFullInlineFunctionOrRemoteCommitOptional) SchemaTitle() string

func (*FunctionsFullInlineFunctionOrRemoteCommitOptional) UnmarshalJSON ¶ 

func (v *FunctionsFullInlineFunctionOrRemoteCommitOptional) UnmarshalJSON(data []byte) error

func (FunctionsFullInlineFunctionOrRemoteCommitOptional) Validate ¶ 

func (v FunctionsFullInlineFunctionOrRemoteCommitOptional) Validate() error

type FunctionsFullRemoteFunction ¶ 

type FunctionsFullRemoteFunction struct {
	Alpha    *FunctionsAlphaRemoteFunction
	Standard *FunctionsRemoteFunction
}

func (FunctionsFullRemoteFunction) MarshalJSON ¶ 

func (v FunctionsFullRemoteFunction) MarshalJSON() ([]byte, error)

func (FunctionsFullRemoteFunction) SchemaTitle ¶ 

func (FunctionsFullRemoteFunction) SchemaTitle() string

func (*FunctionsFullRemoteFunction) UnmarshalJSON ¶ 

func (v *FunctionsFullRemoteFunction) UnmarshalJSON(data []byte) error

func (FunctionsFullRemoteFunction) Validate ¶ 

func (v FunctionsFullRemoteFunction) Validate() error

type FunctionsFunction ¶ 

type FunctionsFunction struct {
	// A remote function with metadata (description, schema, etc.).
	Remote *FunctionsRemoteFunction
	// An inline function definition without metadata.
	Inline *FunctionsInlineFunction
}

A Function definition, either remote or inline.

Functions are composable scoring pipelines that transform structured input into scores. Each task has an `output` expression that transforms its raw result into a `TaskOutputOwned`. The function's final output is the weighted average of all task outputs using profile weights.

Use [`compile_tasks`](Self::compile_tasks) to preview how task expressions resolve for given inputs.

func (FunctionsFunction) MarshalJSON ¶ 

func (v FunctionsFunction) MarshalJSON() ([]byte, error)

func (FunctionsFunction) SchemaTitle ¶ 

func (FunctionsFunction) SchemaTitle() string

func (*FunctionsFunction) UnmarshalJSON ¶ 

func (v *FunctionsFunction) UnmarshalJSON(data []byte) error

func (FunctionsFunction) Validate ¶ 

func (v FunctionsFunction) Validate() error

type FunctionsFunctionType ¶ 

type FunctionsFunctionType struct {
	Scalar *FunctionsFunctionTypeScalar `validate:"omitempty,oneof=scalar.function"`
	Vector *FunctionsFunctionTypeVector `validate:"omitempty,oneof=vector.function"`
}

func (FunctionsFunctionType) MarshalJSON ¶ 

func (v FunctionsFunctionType) MarshalJSON() ([]byte, error)

func (FunctionsFunctionType) SchemaTitle ¶ 

func (FunctionsFunctionType) SchemaTitle() string

func (*FunctionsFunctionType) UnmarshalJSON ¶ 

func (v *FunctionsFunctionType) UnmarshalJSON(data []byte) error

func (FunctionsFunctionType) Validate ¶ 

func (v FunctionsFunctionType) Validate() error

type FunctionsFunctionTypeScalar ¶ 

type FunctionsFunctionTypeScalar string

func (FunctionsFunctionTypeScalar) SchemaVariantTitle ¶ 

func (FunctionsFunctionTypeScalar) SchemaVariantTitle() string

type FunctionsFunctionTypeVector ¶ 

type FunctionsFunctionTypeVector string

func (FunctionsFunctionTypeVector) SchemaVariantTitle ¶ 

func (FunctionsFunctionTypeVector) SchemaVariantTitle() string

type FunctionsGetFunctionProfilePairResponse ¶ 

type FunctionsGetFunctionProfilePairResponse struct {
	// The function.
	Function FunctionsGetFunctionResponse `json:"function"`
	// The profile.
	Profile FunctionsProfilesGetProfileResponse `json:"profile"`
}

Response from getting a function-profile pair.

func (FunctionsGetFunctionProfilePairResponse) SchemaTitle ¶ 

func (FunctionsGetFunctionProfilePairResponse) SchemaTitle() string

func (*FunctionsGetFunctionProfilePairResponse) UnmarshalJSON ¶ 

func (v *FunctionsGetFunctionProfilePairResponse) UnmarshalJSON(data []byte) error

func (FunctionsGetFunctionProfilePairResponse) Validate ¶ 

func (v FunctionsGetFunctionProfilePairResponse) Validate() error

type FunctionsGetFunctionProfilePairUsageRequest ¶ 

type FunctionsGetFunctionProfilePairUsageRequest struct {
	// The function path.
	Function RemotePathCommitOptional `json:"function"`
	// The profile path.
	Profile RemotePathCommitOptional `json:"profile"`
}

Request parameters for getting usage of a specific function-profile pair.

func (FunctionsGetFunctionProfilePairUsageRequest) SchemaTitle ¶ 

func (FunctionsGetFunctionProfilePairUsageRequest) SchemaTitle() string

func (*FunctionsGetFunctionProfilePairUsageRequest) UnmarshalJSON ¶ 

func (v *FunctionsGetFunctionProfilePairUsageRequest) UnmarshalJSON(data []byte) error

func (FunctionsGetFunctionProfilePairUsageRequest) Validate ¶ 

func (v FunctionsGetFunctionProfilePairUsageRequest) Validate() error

type FunctionsGetFunctionResponse ¶ 

type FunctionsGetFunctionResponse struct {
	RemotePath
}

func FunctionsGetFunction ¶ 

func FunctionsGetFunction(ctx context.Context, c *Client, params RemotePathCommitOptional) (*FunctionsGetFunctionResponse, error)

func (FunctionsGetFunctionResponse) SchemaTitle ¶ 

func (FunctionsGetFunctionResponse) SchemaTitle() string

func (FunctionsGetFunctionResponse) Validate ¶ 

func (v FunctionsGetFunctionResponse) Validate() error

type FunctionsInlineFunction ¶ 

type FunctionsInlineFunction struct {
	// Produces a single score in [0, 1].
	Scalar *FunctionsInlineFunctionScalar
	// Produces a vector of scores that sums to 1.
	Vector *FunctionsInlineFunctionVector
}

An inline function definition without metadata.

Used when embedding function logic directly in requests rather than referencing a remote function. Lacks description and input schema fields.

func (FunctionsInlineFunction) MarshalJSON ¶ 

func (v FunctionsInlineFunction) MarshalJSON() ([]byte, error)

func (FunctionsInlineFunction) SchemaTitle ¶ 

func (FunctionsInlineFunction) SchemaTitle() string

func (*FunctionsInlineFunction) UnmarshalJSON ¶ 

func (v *FunctionsInlineFunction) UnmarshalJSON(data []byte) error

func (FunctionsInlineFunction) Validate ¶ 

func (v FunctionsInlineFunction) Validate() error

type FunctionsInlineFunctionScalar ¶ 

type FunctionsInlineFunctionScalar struct {
	// The list of tasks to execute. Tasks with a `map` expression are
	// expanded into multiple instances. Each instance is compiled with
	// `map` set to the current integer index.
	// Receives: `input`, `map` (if mapped).
	Tasks []FunctionsTaskExpression `json:"tasks"`
	Type  string                    `json:"type" validate:"oneof=scalar.function"`
}

Produces a single score in [0, 1].

func (FunctionsInlineFunctionScalar) SchemaVariantTitle ¶ 

func (FunctionsInlineFunctionScalar) SchemaVariantTitle() string

func (*FunctionsInlineFunctionScalar) UnmarshalJSON ¶ 

func (v *FunctionsInlineFunctionScalar) UnmarshalJSON(data []byte) error

type FunctionsInlineFunctionVector ¶ 

type FunctionsInlineFunctionVector struct {
	// Expression transforming an array of inputs computed by `input_split`
	// into a single Input object for the Function.
	// Receives: `input` (as an array).
	// Only required if the request uses a strategy that needs input splitting.
	InputMerge *FunctionsExpressionExpression `json:"input_merge"`
	// Expression transforming input into an input array of the output_length
	// When the Function is executed with any input from the array,
	// The output_length should be 1.
	// Receives: `input`.
	// Only required if the request uses a strategy that needs input splitting.
	InputSplit *FunctionsExpressionExpression `json:"input_split"`
	// The list of tasks to execute. Tasks with a `map` expression are
	// expanded into multiple instances. Each instance is compiled with
	// `map` set to the current integer index.
	// Receives: `input`, `map` (if mapped).
	Tasks []FunctionsTaskExpression `json:"tasks"`
	Type  string                    `json:"type" validate:"oneof=vector.function"`
}

Produces a vector of scores that sums to 1.

func (FunctionsInlineFunctionVector) SchemaVariantTitle ¶ 

func (FunctionsInlineFunctionVector) SchemaVariantTitle() string

func (*FunctionsInlineFunctionVector) UnmarshalJSON ¶ 

func (v *FunctionsInlineFunctionVector) UnmarshalJSON(data []byte) error

type FunctionsInlineProfile ¶ 

type FunctionsInlineProfile struct {
	// Tasks-based profile with per-task configuration.
	Tasks *FunctionsInlineTasksProfile
	// Auto profile that applies a single swarm+weights to all vector completion tasks.
	Auto *SwarmInlineSwarmBase
}

An inline profile, either tasks-based or auto.

func (FunctionsInlineProfile) MarshalJSON ¶ 

func (v FunctionsInlineProfile) MarshalJSON() ([]byte, error)

func (FunctionsInlineProfile) SchemaTitle ¶ 

func (FunctionsInlineProfile) SchemaTitle() string

func (*FunctionsInlineProfile) UnmarshalJSON ¶ 

func (v *FunctionsInlineProfile) UnmarshalJSON(data []byte) error

func (FunctionsInlineProfile) Validate ¶ 

func (v FunctionsInlineProfile) Validate() error

type FunctionsInlineProfileOrRemoteCommitOptional ¶ 

type FunctionsInlineProfileOrRemoteCommitOptional struct {
	Inline *FunctionsInlineProfile
	Remote *RemotePathCommitOptional
}

A profile specification that is either an inline profile definition or a remote path reference.

func (FunctionsInlineProfileOrRemoteCommitOptional) MarshalJSON ¶ 

func (v FunctionsInlineProfileOrRemoteCommitOptional) MarshalJSON() ([]byte, error)

func (FunctionsInlineProfileOrRemoteCommitOptional) SchemaTitle ¶ 

func (FunctionsInlineProfileOrRemoteCommitOptional) SchemaTitle() string

func (*FunctionsInlineProfileOrRemoteCommitOptional) UnmarshalJSON ¶ 

func (v *FunctionsInlineProfileOrRemoteCommitOptional) UnmarshalJSON(data []byte) error

func (FunctionsInlineProfileOrRemoteCommitOptional) Validate ¶ 

func (v FunctionsInlineProfileOrRemoteCommitOptional) Validate() error

type FunctionsInlineTasksProfile ¶ 

type FunctionsInlineTasksProfile struct {
	// Configuration for each task in the corresponding Function.
	Tasks []FunctionsTaskProfile `json:"tasks"`
	// Optional weights for each Task in the corresponding Function.
	// If `None`, uniform weights are used.
	Weights *Weights `json:"weights,omitempty"`
}

An inline tasks-based profile definition without metadata.

func (FunctionsInlineTasksProfile) SchemaTitle ¶ 

func (FunctionsInlineTasksProfile) SchemaTitle() string

func (*FunctionsInlineTasksProfile) UnmarshalJSON ¶ 

func (v *FunctionsInlineTasksProfile) UnmarshalJSON(data []byte) error

func (FunctionsInlineTasksProfile) Validate ¶ 

func (v FunctionsInlineTasksProfile) Validate() error

type FunctionsInventionsDescriptionObject ¶ 

type FunctionsInventionsDescriptionObject struct {
	Description string `json:"description"`
}

func (FunctionsInventionsDescriptionObject) SchemaTitle ¶ 

func (FunctionsInventionsDescriptionObject) SchemaTitle() string

func (*FunctionsInventionsDescriptionObject) UnmarshalJSON ¶ 

func (v *FunctionsInventionsDescriptionObject) UnmarshalJSON(data []byte) error

func (FunctionsInventionsDescriptionObject) Validate ¶ 

func (v FunctionsInventionsDescriptionObject) Validate() error

type FunctionsInventionsEssayObject ¶ 

type FunctionsInventionsEssayObject struct {
	Essay string `json:"essay"`
}

func (FunctionsInventionsEssayObject) SchemaTitle ¶ 

func (FunctionsInventionsEssayObject) SchemaTitle() string

func (*FunctionsInventionsEssayObject) UnmarshalJSON ¶ 

func (v *FunctionsInventionsEssayObject) UnmarshalJSON(data []byte) error

func (FunctionsInventionsEssayObject) Validate ¶ 

func (v FunctionsInventionsEssayObject) Validate() error

type FunctionsInventionsEssayTasksObject ¶ 

type FunctionsInventionsEssayTasksObject struct {
	EssayTasks string `json:"essay_tasks"`
}

func (FunctionsInventionsEssayTasksObject) SchemaTitle ¶ 

func (FunctionsInventionsEssayTasksObject) SchemaTitle() string

func (*FunctionsInventionsEssayTasksObject) UnmarshalJSON ¶ 

func (v *FunctionsInventionsEssayTasksObject) UnmarshalJSON(data []byte) error

func (FunctionsInventionsEssayTasksObject) Validate ¶ 

func (v FunctionsInventionsEssayTasksObject) Validate() error

type FunctionsInventionsIndexObject ¶ 

type FunctionsInventionsIndexObject struct {
	Index uint64 `json:"index" validate:"min=0,max=18446744073709551615"`
}

func (FunctionsInventionsIndexObject) SchemaTitle ¶ 

func (FunctionsInventionsIndexObject) SchemaTitle() string

func (*FunctionsInventionsIndexObject) UnmarshalJSON ¶ 

func (v *FunctionsInventionsIndexObject) UnmarshalJSON(data []byte) error

func (FunctionsInventionsIndexObject) Validate ¶ 

func (v FunctionsInventionsIndexObject) Validate() error

type FunctionsInventionsPromptsGetPromptResponse ¶ 

type FunctionsInventionsPromptsGetPromptResponse struct {
	RemotePath
}

func FunctionsInventionsPromptsGetPrompt ¶ 

func FunctionsInventionsPromptsGetPrompt(ctx context.Context, c *Client, params RemotePathCommitOptional) (*FunctionsInventionsPromptsGetPromptResponse, error)

func (FunctionsInventionsPromptsGetPromptResponse) SchemaTitle ¶ 

func (FunctionsInventionsPromptsGetPromptResponse) SchemaTitle() string

func (FunctionsInventionsPromptsGetPromptResponse) Validate ¶ 

func (v FunctionsInventionsPromptsGetPromptResponse) Validate() error

type FunctionsInventionsPromptsInlinePrompt ¶ 

type FunctionsInventionsPromptsInlinePrompt struct {
	DescriptionStep []FunctionsInventionsPromptsStepPromptExpression `json:"description_step"`
	EssayStep       []FunctionsInventionsPromptsStepPromptExpression `json:"essay_step"`
	EssayTasksStep  []FunctionsInventionsPromptsStepPromptExpression `json:"essay_tasks_step"`
	InputSchemaStep []FunctionsInventionsPromptsStepPromptExpression `json:"input_schema_step"`
	TasksStep       []FunctionsInventionsPromptsStepPromptExpression `json:"tasks_step"`
}

Inline invention prompt configuration for all steps.

func (FunctionsInventionsPromptsInlinePrompt) SchemaTitle ¶ 

func (FunctionsInventionsPromptsInlinePrompt) SchemaTitle() string

func (*FunctionsInventionsPromptsInlinePrompt) UnmarshalJSON ¶ 

func (v *FunctionsInventionsPromptsInlinePrompt) UnmarshalJSON(data []byte) error

func (FunctionsInventionsPromptsInlinePrompt) Validate ¶ 

func (v FunctionsInventionsPromptsInlinePrompt) Validate() error

type FunctionsInventionsPromptsInlinePromptOrRemoteCommitOptional ¶ 

type FunctionsInventionsPromptsInlinePromptOrRemoteCommitOptional struct {
	Inline *FunctionsInventionsPromptsInlinePrompt
	Remote *RemotePathCommitOptional
}

A prompt specification that is either an inline prompt definition or a remote path reference.

func (FunctionsInventionsPromptsInlinePromptOrRemoteCommitOptional) MarshalJSON ¶ 

func (v FunctionsInventionsPromptsInlinePromptOrRemoteCommitOptional) MarshalJSON() ([]byte, error)

func (FunctionsInventionsPromptsInlinePromptOrRemoteCommitOptional) SchemaTitle ¶ 

func (FunctionsInventionsPromptsInlinePromptOrRemoteCommitOptional) SchemaTitle() string

func (*FunctionsInventionsPromptsInlinePromptOrRemoteCommitOptional) UnmarshalJSON ¶ 

func (v *FunctionsInventionsPromptsInlinePromptOrRemoteCommitOptional) UnmarshalJSON(data []byte) error

func (FunctionsInventionsPromptsInlinePromptOrRemoteCommitOptional) Validate ¶ 

func (v FunctionsInventionsPromptsInlinePromptOrRemoteCommitOptional) Validate() error

type FunctionsInventionsPromptsListPromptResponse ¶ 

type FunctionsInventionsPromptsListPromptResponse struct {
	// List of available prompts.
	Data []RemotePath `json:"data"`
}

Response from listing prompts.

func FunctionsInventionsPromptsListPrompts ¶ 

func FunctionsInventionsPromptsListPrompts(ctx context.Context, c *Client, params FunctionsInventionsPromptsListPromptsRequest) (*FunctionsInventionsPromptsListPromptResponse, error)

func (FunctionsInventionsPromptsListPromptResponse) SchemaTitle ¶ 

func (FunctionsInventionsPromptsListPromptResponse) SchemaTitle() string

func (*FunctionsInventionsPromptsListPromptResponse) UnmarshalJSON ¶ 

func (v *FunctionsInventionsPromptsListPromptResponse) UnmarshalJSON(data []byte) error

func (FunctionsInventionsPromptsListPromptResponse) Validate ¶ 

func (v FunctionsInventionsPromptsListPromptResponse) Validate() error

type FunctionsInventionsPromptsListPromptsRequest ¶ 

type FunctionsInventionsPromptsListPromptsRequest struct {
	// Optional source filter for listing prompts.
	Source *FunctionsInventionsPromptsListPromptsSource `json:"source,omitempty"`
}

Query parameters for the list prompts endpoint.

func (FunctionsInventionsPromptsListPromptsRequest) SchemaTitle ¶ 

func (FunctionsInventionsPromptsListPromptsRequest) SchemaTitle() string

func (FunctionsInventionsPromptsListPromptsRequest) Validate ¶ 

func (v FunctionsInventionsPromptsListPromptsRequest) Validate() error

type FunctionsInventionsPromptsListPromptsSource ¶ 

type FunctionsInventionsPromptsListPromptsSource struct {
	All         *string `validate:"omitempty,oneof=all"`
	Mock        *string `validate:"omitempty,oneof=mock"`
	Filesystem  *string `validate:"omitempty,oneof=filesystem"`
	Objectiveai *string `validate:"omitempty,oneof=objectiveai"`
}

Source filter for listing prompts.

func (FunctionsInventionsPromptsListPromptsSource) MarshalJSON ¶ 

func (v FunctionsInventionsPromptsListPromptsSource) MarshalJSON() ([]byte, error)

func (FunctionsInventionsPromptsListPromptsSource) SchemaTitle ¶ 

func (FunctionsInventionsPromptsListPromptsSource) SchemaTitle() string

func (*FunctionsInventionsPromptsListPromptsSource) UnmarshalJSON ¶ 

func (v *FunctionsInventionsPromptsListPromptsSource) UnmarshalJSON(data []byte) error

func (FunctionsInventionsPromptsListPromptsSource) Validate ¶ 

func (v FunctionsInventionsPromptsListPromptsSource) Validate() error

type FunctionsInventionsPromptsPrompt ¶ 

type FunctionsInventionsPromptsPrompt struct {
	// A remote prompt with metadata.
	Remote *FunctionsInventionsPromptsRemotePrompt
	// An inline prompt definition.
	Inline *FunctionsInventionsPromptsInlinePrompt
}

A Prompt definition, either remote or inline.

func (FunctionsInventionsPromptsPrompt) MarshalJSON ¶ 

func (v FunctionsInventionsPromptsPrompt) MarshalJSON() ([]byte, error)

func (FunctionsInventionsPromptsPrompt) SchemaTitle ¶ 

func (FunctionsInventionsPromptsPrompt) SchemaTitle() string

func (*FunctionsInventionsPromptsPrompt) UnmarshalJSON ¶ 

func (v *FunctionsInventionsPromptsPrompt) UnmarshalJSON(data []byte) error

func (FunctionsInventionsPromptsPrompt) Validate ¶ 

func (v FunctionsInventionsPromptsPrompt) Validate() error

type FunctionsInventionsPromptsRemotePrompt ¶ 

type FunctionsInventionsPromptsRemotePrompt struct {
	FunctionsInventionsPromptsInlinePrompt
	// Human-readable description of the prompt.
	Description string `json:"description"`
}

A remote prompt with description and inline prompt fields.

func (FunctionsInventionsPromptsRemotePrompt) MarshalJSON ¶ 

func (v FunctionsInventionsPromptsRemotePrompt) MarshalJSON() ([]byte, error)

func (FunctionsInventionsPromptsRemotePrompt) SchemaTitle ¶ 

func (FunctionsInventionsPromptsRemotePrompt) SchemaTitle() string

func (*FunctionsInventionsPromptsRemotePrompt) UnmarshalJSON ¶ 

func (v *FunctionsInventionsPromptsRemotePrompt) UnmarshalJSON(data []byte) error

func (FunctionsInventionsPromptsRemotePrompt) Validate ¶ 

func (v FunctionsInventionsPromptsRemotePrompt) Validate() error

type FunctionsInventionsPromptsStepPromptExpression ¶ 

type FunctionsInventionsPromptsStepPromptExpression struct {
	Type []FunctionsInventionsPromptsStepPromptType `json:"type"`
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Value FunctionsInventionsPromptsStepPromptExpressionValue `json:"value"`
}

A prompt for a single invention step, applicable to one or more state types.

func (FunctionsInventionsPromptsStepPromptExpression) SchemaTitle ¶ 

func (FunctionsInventionsPromptsStepPromptExpression) SchemaTitle() string

func (*FunctionsInventionsPromptsStepPromptExpression) UnmarshalJSON ¶ 

func (v *FunctionsInventionsPromptsStepPromptExpression) UnmarshalJSON(data []byte) error

func (FunctionsInventionsPromptsStepPromptExpression) Validate ¶ 

func (v FunctionsInventionsPromptsStepPromptExpression) Validate() error

type FunctionsInventionsPromptsStepPromptExpressionValue ¶ 

type FunctionsInventionsPromptsStepPromptExpressionValue struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *FunctionsInventionsPromptsStepPromptExpressionValueValue
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (FunctionsInventionsPromptsStepPromptExpressionValue) MarshalJSON ¶ 

func (v FunctionsInventionsPromptsStepPromptExpressionValue) MarshalJSON() ([]byte, error)

func (*FunctionsInventionsPromptsStepPromptExpressionValue) UnmarshalJSON ¶ 

func (v *FunctionsInventionsPromptsStepPromptExpressionValue) UnmarshalJSON(data []byte) error

func (FunctionsInventionsPromptsStepPromptExpressionValue) Validate ¶ 

func (v FunctionsInventionsPromptsStepPromptExpressionValue) Validate() error

type FunctionsInventionsPromptsStepPromptExpressionValueValue ¶ 

type FunctionsInventionsPromptsStepPromptExpressionValueValue string

func (FunctionsInventionsPromptsStepPromptExpressionValueValue) SchemaVariantTitle ¶ 

func (FunctionsInventionsPromptsStepPromptExpressionValueValue) SchemaVariantTitle() string

type FunctionsInventionsPromptsStepPromptType ¶ 

type FunctionsInventionsPromptsStepPromptType struct {
	AlphaScalarBranchFunction *string `validate:"omitempty,oneof=alpha.scalar.branch.function"`
	AlphaScalarLeafFunction   *string `validate:"omitempty,oneof=alpha.scalar.leaf.function"`
	AlphaVectorBranchFunction *string `validate:"omitempty,oneof=alpha.vector.branch.function"`
	AlphaVectorLeafFunction   *string `validate:"omitempty,oneof=alpha.vector.leaf.function"`
}

The type of invention state a prompt applies to.

func (FunctionsInventionsPromptsStepPromptType) MarshalJSON ¶ 

func (v FunctionsInventionsPromptsStepPromptType) MarshalJSON() ([]byte, error)

func (FunctionsInventionsPromptsStepPromptType) SchemaTitle ¶ 

func (FunctionsInventionsPromptsStepPromptType) SchemaTitle() string

func (*FunctionsInventionsPromptsStepPromptType) UnmarshalJSON ¶ 

func (v *FunctionsInventionsPromptsStepPromptType) UnmarshalJSON(data []byte) error

func (FunctionsInventionsPromptsStepPromptType) Validate ¶ 

func (v FunctionsInventionsPromptsStepPromptType) Validate() error

type FunctionsInventionsPromptsUsagePromptResponse ¶ 

type FunctionsInventionsPromptsUsagePromptResponse struct {
	// Total completion tokens used.
	CompletionTokens uint64 `json:"completion_tokens" validate:"min=0,max=18446744073709551615"`
	// Total prompt tokens used.
	PromptTokens uint64 `json:"prompt_tokens" validate:"min=0,max=18446744073709551615"`
	// Total number of requests made with this prompt.
	Requests uint64 `json:"requests" validate:"min=0,max=18446744073709551615"`
	// Total cost incurred.
	TotalCost float64 `json:"total_cost" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

Usage statistics for a prompt.

func FunctionsInventionsPromptsGetPromptUsage ¶ 

func FunctionsInventionsPromptsGetPromptUsage(ctx context.Context, c *Client, params RemotePathCommitOptional) (*FunctionsInventionsPromptsUsagePromptResponse, error)

func (FunctionsInventionsPromptsUsagePromptResponse) SchemaTitle ¶ 

func (FunctionsInventionsPromptsUsagePromptResponse) SchemaTitle() string

func (*FunctionsInventionsPromptsUsagePromptResponse) UnmarshalJSON ¶ 

func (v *FunctionsInventionsPromptsUsagePromptResponse) UnmarshalJSON(data []byte) error

func (FunctionsInventionsPromptsUsagePromptResponse) Validate ¶ 

func (v FunctionsInventionsPromptsUsagePromptResponse) Validate() error

type FunctionsInventionsRecursiveRequestFunctionInventionRecursiveCreateParams ¶ 

type FunctionsInventionsRecursiveRequestFunctionInventionRecursiveCreateParams struct {
	Agent AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional `json:"agent"`
	// Continuation from a previous completion, as a base64-encoded string.
	Continuation *string `json:"continuation,omitempty"`
	// Maximum number of retries per invention step.
	// Each step is one agent completion (which itself may loop internally
	// via tool calls). If the step's validation still fails after the
	// agent loop ends, the step is retried up to this many times.
	// Defaults to 3 if not specified.
	MaxStepRetries *uint32                                                      `json:"max_step_retries,omitempty" validate:"omitempty,min=0,max=4294967295"`
	Overwrite      *bool                                                        `json:"overwrite,omitempty"`
	Prompt         FunctionsInventionsPromptsInlinePromptOrRemoteCommitOptional `json:"prompt"`
	Provider       *AgentCompletionsRequestProvider                             `json:"provider,omitempty"`
	Remote         Remote                                                       `json:"remote"`
	Seed           *int64                                                       `json:"seed,omitempty" validate:"omitempty,min=-9223372036854775808,max=9223372036854775807"`
	State          FunctionsInventionsStateParamsStateOrRemoteCommitOptional    `json:"state"`
	Stream         *bool                                                        `json:"stream,omitempty"`
}

func (FunctionsInventionsRecursiveRequestFunctionInventionRecursiveCreateParams) SchemaTitle ¶ 

func (FunctionsInventionsRecursiveRequestFunctionInventionRecursiveCreateParams) SchemaTitle() string

func (*FunctionsInventionsRecursiveRequestFunctionInventionRecursiveCreateParams) UnmarshalJSON ¶ 

func (v *FunctionsInventionsRecursiveRequestFunctionInventionRecursiveCreateParams) UnmarshalJSON(data []byte) error

func (FunctionsInventionsRecursiveRequestFunctionInventionRecursiveCreateParams) Validate ¶ 

func (v FunctionsInventionsRecursiveRequestFunctionInventionRecursiveCreateParams) Validate() error

type FunctionsInventionsRecursiveResponseStreamingFunctionInventionChunk ¶ 

type FunctionsInventionsRecursiveResponseStreamingFunctionInventionChunk struct {
	Completions []FunctionsInventionsResponseStreamingAgentCompletionChunk `json:"completions"`
	Created     uint64                                                     `json:"created" validate:"min=0,max=18446744073709551615"`
	Error       *ErrorResponseError                                        `json:"error,omitempty"`
	Function    *FunctionsFullRemoteFunction                               `json:"function,omitempty"`
	ID          string                                                     `json:"id"`
	Index       uint64                                                     `json:"index" validate:"min=0,max=18446744073709551615"`
	Object      FunctionsInventionsResponseStreamingObject                 `json:"object"`
	Path        *RemotePath                                                `json:"path,omitempty"`
	State       *FunctionsInventionsStateState                             `json:"state,omitempty"`
	Usage       *AgentCompletionsResponseUsage                             `json:"usage,omitempty"`
}

func (*FunctionsInventionsRecursiveResponseStreamingFunctionInventionChunk) Push ¶ 

func (v *FunctionsInventionsRecursiveResponseStreamingFunctionInventionChunk) Push(other *FunctionsInventionsRecursiveResponseStreamingFunctionInventionChunk)

Push accumulates another recursive FunctionInventionChunk into this one.

func (FunctionsInventionsRecursiveResponseStreamingFunctionInventionChunk) SchemaTitle ¶ 

func (FunctionsInventionsRecursiveResponseStreamingFunctionInventionChunk) SchemaTitle() string

func (*FunctionsInventionsRecursiveResponseStreamingFunctionInventionChunk) UnmarshalJSON ¶ 

func (v *FunctionsInventionsRecursiveResponseStreamingFunctionInventionChunk) UnmarshalJSON(data []byte) error

func (FunctionsInventionsRecursiveResponseStreamingFunctionInventionChunk) Validate ¶ 

func (v FunctionsInventionsRecursiveResponseStreamingFunctionInventionChunk) Validate() error

type FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk ¶ 

type FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk struct {
	Created          uint64                                                                `json:"created" validate:"min=0,max=18446744073709551615"`
	ID               string                                                                `json:"id"`
	Inventions       []FunctionsInventionsRecursiveResponseStreamingFunctionInventionChunk `json:"inventions"`
	InventionsErrors *bool                                                                 `json:"inventions_errors,omitempty"`
	Object           FunctionsInventionsRecursiveResponseStreamingObject                   `json:"object"`
	Usage            *AgentCompletionsResponseUsage                                        `json:"usage,omitempty"`
}

func FunctionInventionRecursiveChunkMerged ¶ 

func FunctionInventionRecursiveChunkMerged(a, b FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk) (*FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk, error)

FunctionInventionRecursiveChunkMerged merges two FunctionInventionRecursiveChunks via push.

func FunctionInventionRecursiveChunkNormalized ¶ 

func FunctionInventionRecursiveChunkNormalized(chunk FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk) (*FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk, error)

FunctionInventionRecursiveChunkNormalized normalizes a FunctionInventionRecursiveChunk.

func GenerateFunctionInventionRecursiveChunk ¶ 

func GenerateFunctionInventionRecursiveChunk(hasSeed bool, seed int64) (*FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk, error)

GenerateFunctionInventionRecursiveChunk generates a random FunctionInventionRecursiveChunk from a seed.

func (*FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk) Push ¶ 

func (v *FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk) Push(other *FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk)

Push accumulates another FunctionInventionRecursiveChunk into this one.

func (FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk) SchemaTitle ¶ 

func (FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk) SchemaTitle() string

func (*FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk) UnmarshalJSON ¶ 

func (v *FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk) UnmarshalJSON(data []byte) error

func (FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk) Validate ¶ 

func (v FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk) Validate() error

type FunctionsInventionsRecursiveResponseStreamingObject ¶ 

type FunctionsInventionsRecursiveResponseStreamingObject struct {
	AlphaScalarFunctionInventionRecursiveChunk *string `validate:"omitempty,oneof=alpha.scalar.function.invention.recursive.chunk"`
	AlphaVectorFunctionInventionRecursiveChunk *string `validate:"omitempty,oneof=alpha.vector.function.invention.recursive.chunk"`
}

func (FunctionsInventionsRecursiveResponseStreamingObject) MarshalJSON ¶ 

func (v FunctionsInventionsRecursiveResponseStreamingObject) MarshalJSON() ([]byte, error)

func (FunctionsInventionsRecursiveResponseStreamingObject) SchemaTitle ¶ 

func (FunctionsInventionsRecursiveResponseStreamingObject) SchemaTitle() string

func (*FunctionsInventionsRecursiveResponseStreamingObject) UnmarshalJSON ¶ 

func (v *FunctionsInventionsRecursiveResponseStreamingObject) UnmarshalJSON(data []byte) error

func (FunctionsInventionsRecursiveResponseStreamingObject) Validate ¶ 

func (v FunctionsInventionsRecursiveResponseStreamingObject) Validate() error

type FunctionsInventionsRecursiveResponseUnaryFunctionInvention ¶ 

type FunctionsInventionsRecursiveResponseUnaryFunctionInvention struct {
	Completions []FunctionsInventionsResponseUnaryAgentCompletion `json:"completions"`
	Created     uint64                                            `json:"created" validate:"min=0,max=18446744073709551615"`
	Error       *ErrorResponseError                               `json:"error"`
	Function    *FunctionsFullRemoteFunction                      `json:"function"`
	ID          string                                            `json:"id"`
	Index       uint64                                            `json:"index" validate:"min=0,max=18446744073709551615"`
	Object      FunctionsInventionsResponseUnaryObject            `json:"object"`
	Path        *RemotePath                                       `json:"path"`
	State       FunctionsInventionsStateState                     `json:"state"`
	Usage       AgentCompletionsResponseUsage                     `json:"usage"`
}

func (FunctionsInventionsRecursiveResponseUnaryFunctionInvention) SchemaTitle ¶ 

func (FunctionsInventionsRecursiveResponseUnaryFunctionInvention) SchemaTitle() string

func (*FunctionsInventionsRecursiveResponseUnaryFunctionInvention) UnmarshalJSON ¶ 

func (v *FunctionsInventionsRecursiveResponseUnaryFunctionInvention) UnmarshalJSON(data []byte) error

func (FunctionsInventionsRecursiveResponseUnaryFunctionInvention) Validate ¶ 

func (v FunctionsInventionsRecursiveResponseUnaryFunctionInvention) Validate() error

type FunctionsInventionsRecursiveResponseUnaryFunctionInventionRecursive ¶ 

type FunctionsInventionsRecursiveResponseUnaryFunctionInventionRecursive struct {
	Created          uint64                                                       `json:"created" validate:"min=0,max=18446744073709551615"`
	ID               string                                                       `json:"id"`
	Inventions       []FunctionsInventionsRecursiveResponseUnaryFunctionInvention `json:"inventions"`
	InventionsErrors bool                                                         `json:"inventions_errors"`
	Object           FunctionsInventionsRecursiveResponseUnaryObject              `json:"object"`
	Usage            AgentCompletionsResponseUsage                                `json:"usage"`
}

func FunctionInventionRecursiveChunkToUnary ¶ 

func FunctionInventionRecursiveChunkToUnary(chunk FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk) (*FunctionsInventionsRecursiveResponseUnaryFunctionInventionRecursive, error)

FunctionInventionRecursiveChunkToUnary converts an accumulated chunk to a unary FunctionInventionRecursive.

func FunctionsInventionsRecursiveCreateFunctionInventionRecursiveUnary ¶ 

func FunctionsInventionsRecursiveCreateFunctionInventionRecursiveUnary(ctx context.Context, c *Client, params FunctionsInventionsRecursiveRequestFunctionInventionRecursiveCreateParams) (*FunctionsInventionsRecursiveResponseUnaryFunctionInventionRecursive, error)

func NormalizeFunctionInventionRecursiveForTests ¶ 

func NormalizeFunctionInventionRecursiveForTests(v FunctionsInventionsRecursiveResponseUnaryFunctionInventionRecursive) (*FunctionsInventionsRecursiveResponseUnaryFunctionInventionRecursive, error)

NormalizeFunctionInventionRecursiveForTests normalizes a FunctionInventionRecursive by round-tripping through serde.

func (FunctionsInventionsRecursiveResponseUnaryFunctionInventionRecursive) SchemaTitle ¶ 

func (FunctionsInventionsRecursiveResponseUnaryFunctionInventionRecursive) SchemaTitle() string

func (*FunctionsInventionsRecursiveResponseUnaryFunctionInventionRecursive) UnmarshalJSON ¶ 

func (v *FunctionsInventionsRecursiveResponseUnaryFunctionInventionRecursive) UnmarshalJSON(data []byte) error

func (FunctionsInventionsRecursiveResponseUnaryFunctionInventionRecursive) Validate ¶ 

func (v FunctionsInventionsRecursiveResponseUnaryFunctionInventionRecursive) Validate() error

type FunctionsInventionsRecursiveResponseUnaryObject ¶ 

type FunctionsInventionsRecursiveResponseUnaryObject struct {
	AlphaScalarFunctionInventionRecursive *string `validate:"omitempty,oneof=alpha.scalar.function.invention.recursive"`
	AlphaVectorFunctionInventionRecursive *string `validate:"omitempty,oneof=alpha.vector.function.invention.recursive"`
}

func (FunctionsInventionsRecursiveResponseUnaryObject) MarshalJSON ¶ 

func (v FunctionsInventionsRecursiveResponseUnaryObject) MarshalJSON() ([]byte, error)

func (FunctionsInventionsRecursiveResponseUnaryObject) SchemaTitle ¶ 

func (FunctionsInventionsRecursiveResponseUnaryObject) SchemaTitle() string

func (*FunctionsInventionsRecursiveResponseUnaryObject) UnmarshalJSON ¶ 

func (v *FunctionsInventionsRecursiveResponseUnaryObject) UnmarshalJSON(data []byte) error

func (FunctionsInventionsRecursiveResponseUnaryObject) Validate ¶ 

func (v FunctionsInventionsRecursiveResponseUnaryObject) Validate() error

type FunctionsInventionsRequestFunctionInventionCreateParams ¶ 

type FunctionsInventionsRequestFunctionInventionCreateParams struct {
	Agent AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional `json:"agent"`
	// Continuation from a previous completion, as a base64-encoded string.
	Continuation *string `json:"continuation,omitempty"`
	// Maximum number of retries per invention step.
	// Each step is one agent completion (which itself may loop internally
	// via tool calls). If the step's validation still fails after the
	// agent loop ends, the step is retried up to this many times.
	// Defaults to 3 if not specified.
	MaxStepRetries *uint32                                                      `json:"max_step_retries,omitempty" validate:"omitempty,min=0,max=4294967295"`
	Overwrite      *bool                                                        `json:"overwrite,omitempty"`
	Prompt         FunctionsInventionsPromptsInlinePromptOrRemoteCommitOptional `json:"prompt"`
	Provider       *AgentCompletionsRequestProvider                             `json:"provider,omitempty"`
	Remote         *Remote                                                      `json:"remote,omitempty"`
	Seed           *int64                                                       `json:"seed,omitempty" validate:"omitempty,min=-9223372036854775808,max=9223372036854775807"`
	State          FunctionsInventionsStateParamsStateOrRemoteCommitOptional    `json:"state"`
	Stream         *bool                                                        `json:"stream,omitempty"`
}

func (FunctionsInventionsRequestFunctionInventionCreateParams) SchemaTitle ¶ 

func (FunctionsInventionsRequestFunctionInventionCreateParams) SchemaTitle() string

func (*FunctionsInventionsRequestFunctionInventionCreateParams) UnmarshalJSON ¶ 

func (v *FunctionsInventionsRequestFunctionInventionCreateParams) UnmarshalJSON(data []byte) error

func (FunctionsInventionsRequestFunctionInventionCreateParams) Validate ¶ 

func (v FunctionsInventionsRequestFunctionInventionCreateParams) Validate() error

type FunctionsInventionsResponseStreamingAgentCompletionChunk ¶ 

type FunctionsInventionsResponseStreamingAgentCompletionChunk struct {
	// Continuation state for multi-turn conversations (only present in the final chunk).
	Continuation *string `json:"continuation,omitempty"`
	Created      uint64  `json:"created" validate:"min=0,max=18446744073709551615"`
	// Error details if this completion failed.
	Error    *ErrorResponseError                             `json:"error,omitempty"`
	ID       string                                          `json:"id"`
	Index    uint64                                          `json:"index" validate:"min=0,max=18446744073709551615"`
	Messages []AgentCompletionsResponseStreamingMessageChunk `json:"messages"`
	// The object type (always "agent.completion.chunk").
	Object AgentCompletionsResponseStreamingObject `json:"object"`
	// Upstream provider
	Upstream AgentUpstream `json:"upstream"`
	// Token usage (only present in the final chunk).
	Usage *AgentCompletionsResponseUsage `json:"usage,omitempty"`
}

A chunk of a streaming agent completion response.

Multiple chunks are received via Server-Sent Events and can be accumulated into a complete [`AgentCompletion`](response::unary::AgentCompletion) using the [`push`](Self::push) method.

func (*FunctionsInventionsResponseStreamingAgentCompletionChunk) Push ¶ 

func (v *FunctionsInventionsResponseStreamingAgentCompletionChunk) Push(other *FunctionsInventionsResponseStreamingAgentCompletionChunk)

Push accumulates another inventions AgentCompletionChunk into this one.

func (FunctionsInventionsResponseStreamingAgentCompletionChunk) SchemaTitle ¶ 

func (FunctionsInventionsResponseStreamingAgentCompletionChunk) SchemaTitle() string

func (*FunctionsInventionsResponseStreamingAgentCompletionChunk) UnmarshalJSON ¶ 

func (v *FunctionsInventionsResponseStreamingAgentCompletionChunk) UnmarshalJSON(data []byte) error

func (FunctionsInventionsResponseStreamingAgentCompletionChunk) Validate ¶ 

func (v FunctionsInventionsResponseStreamingAgentCompletionChunk) Validate() error

type FunctionsInventionsResponseStreamingFunctionInventionChunk ¶ 

type FunctionsInventionsResponseStreamingFunctionInventionChunk struct {
	Completions []FunctionsInventionsResponseStreamingAgentCompletionChunk `json:"completions"`
	Created     uint64                                                     `json:"created" validate:"min=0,max=18446744073709551615"`
	Error       *ErrorResponseError                                        `json:"error,omitempty"`
	Function    *FunctionsFullRemoteFunction                               `json:"function,omitempty"`
	ID          string                                                     `json:"id"`
	Object      FunctionsInventionsResponseStreamingObject                 `json:"object"`
	Path        *RemotePath                                                `json:"path,omitempty"`
	State       *FunctionsInventionsStateState                             `json:"state,omitempty"`
	Usage       *AgentCompletionsResponseUsage                             `json:"usage,omitempty"`
}

func FunctionInventionChunkMerged ¶ 

func FunctionInventionChunkMerged(a, b FunctionsInventionsResponseStreamingFunctionInventionChunk) (*FunctionsInventionsResponseStreamingFunctionInventionChunk, error)

FunctionInventionChunkMerged merges two FunctionInventionChunks via push.

func FunctionInventionChunkNormalized ¶ 

func FunctionInventionChunkNormalized(chunk FunctionsInventionsResponseStreamingFunctionInventionChunk) (*FunctionsInventionsResponseStreamingFunctionInventionChunk, error)

FunctionInventionChunkNormalized normalizes a FunctionInventionChunk.

func GenerateFunctionInventionChunk ¶ 

func GenerateFunctionInventionChunk(hasSeed bool, seed int64) (*FunctionsInventionsResponseStreamingFunctionInventionChunk, error)

GenerateFunctionInventionChunk generates a random FunctionInventionChunk from a seed.

func (*FunctionsInventionsResponseStreamingFunctionInventionChunk) Push ¶ 

func (v *FunctionsInventionsResponseStreamingFunctionInventionChunk) Push(other *FunctionsInventionsResponseStreamingFunctionInventionChunk)

Push accumulates another FunctionInventionChunk into this one.

func (FunctionsInventionsResponseStreamingFunctionInventionChunk) SchemaTitle ¶ 

func (FunctionsInventionsResponseStreamingFunctionInventionChunk) SchemaTitle() string

func (*FunctionsInventionsResponseStreamingFunctionInventionChunk) UnmarshalJSON ¶ 

func (v *FunctionsInventionsResponseStreamingFunctionInventionChunk) UnmarshalJSON(data []byte) error

func (FunctionsInventionsResponseStreamingFunctionInventionChunk) Validate ¶ 

func (v FunctionsInventionsResponseStreamingFunctionInventionChunk) Validate() error

type FunctionsInventionsResponseStreamingObject ¶ 

type FunctionsInventionsResponseStreamingObject struct {
	AlphaScalarFunctionInventionChunk *string `validate:"omitempty,oneof=alpha.scalar.function.invention.chunk"`
	AlphaVectorFunctionInventionChunk *string `validate:"omitempty,oneof=alpha.vector.function.invention.chunk"`
}

func (FunctionsInventionsResponseStreamingObject) MarshalJSON ¶ 

func (v FunctionsInventionsResponseStreamingObject) MarshalJSON() ([]byte, error)

func (FunctionsInventionsResponseStreamingObject) SchemaTitle ¶ 

func (FunctionsInventionsResponseStreamingObject) SchemaTitle() string

func (*FunctionsInventionsResponseStreamingObject) UnmarshalJSON ¶ 

func (v *FunctionsInventionsResponseStreamingObject) UnmarshalJSON(data []byte) error

func (FunctionsInventionsResponseStreamingObject) Validate ¶ 

func (v FunctionsInventionsResponseStreamingObject) Validate() error

type FunctionsInventionsResponseUnaryAgentCompletion ¶ 

type FunctionsInventionsResponseUnaryAgentCompletion struct {
	// Continuation state for multi-turn conversations.
	Continuation *string `json:"continuation"`
	Created      uint64  `json:"created" validate:"min=0,max=18446744073709551615"`
	// Error details if this completion failed.
	Error    *ErrorResponseError                    `json:"error"`
	ID       string                                 `json:"id"`
	Index    uint64                                 `json:"index" validate:"min=0,max=18446744073709551615"`
	Messages []AgentCompletionsResponseUnaryMessage `json:"messages"`
	// The object type (always "agent.completion").
	Object AgentCompletionsResponseUnaryObject `json:"object"`
	// Upstream provider
	Upstream AgentUpstream                 `json:"upstream"`
	Usage    AgentCompletionsResponseUsage `json:"usage"`
}

A complete agent completion response.

func (FunctionsInventionsResponseUnaryAgentCompletion) SchemaTitle ¶ 

func (FunctionsInventionsResponseUnaryAgentCompletion) SchemaTitle() string

func (*FunctionsInventionsResponseUnaryAgentCompletion) UnmarshalJSON ¶ 

func (v *FunctionsInventionsResponseUnaryAgentCompletion) UnmarshalJSON(data []byte) error

func (FunctionsInventionsResponseUnaryAgentCompletion) Validate ¶ 

func (v FunctionsInventionsResponseUnaryAgentCompletion) Validate() error

type FunctionsInventionsResponseUnaryFunctionInvention ¶ 

type FunctionsInventionsResponseUnaryFunctionInvention struct {
	Completions []FunctionsInventionsResponseUnaryAgentCompletion `json:"completions"`
	Created     uint64                                            `json:"created" validate:"min=0,max=18446744073709551615"`
	Error       *ErrorResponseError                               `json:"error"`
	Function    *FunctionsFullRemoteFunction                      `json:"function"`
	ID          string                                            `json:"id"`
	Object      FunctionsInventionsResponseUnaryObject            `json:"object"`
	Path        *RemotePath                                       `json:"path"`
	State       FunctionsInventionsStateState                     `json:"state"`
	Usage       AgentCompletionsResponseUsage                     `json:"usage"`
}

func FunctionInventionChunkToUnary ¶ 

func FunctionInventionChunkToUnary(chunk FunctionsInventionsResponseStreamingFunctionInventionChunk) (*FunctionsInventionsResponseUnaryFunctionInvention, error)

FunctionInventionChunkToUnary converts an accumulated chunk to a unary FunctionInvention.

func FunctionsInventionsCreateFunctionInventionUnary ¶ 

func FunctionsInventionsCreateFunctionInventionUnary(ctx context.Context, c *Client, params FunctionsInventionsRequestFunctionInventionCreateParams) (*FunctionsInventionsResponseUnaryFunctionInvention, error)

func NormalizeFunctionInventionForTests ¶ 

func NormalizeFunctionInventionForTests(v FunctionsInventionsResponseUnaryFunctionInvention) (*FunctionsInventionsResponseUnaryFunctionInvention, error)

NormalizeFunctionInventionForTests normalizes a FunctionInvention by round-tripping through serde.

func (FunctionsInventionsResponseUnaryFunctionInvention) SchemaTitle ¶ 

func (FunctionsInventionsResponseUnaryFunctionInvention) SchemaTitle() string

func (*FunctionsInventionsResponseUnaryFunctionInvention) UnmarshalJSON ¶ 

func (v *FunctionsInventionsResponseUnaryFunctionInvention) UnmarshalJSON(data []byte) error

func (FunctionsInventionsResponseUnaryFunctionInvention) Validate ¶ 

func (v FunctionsInventionsResponseUnaryFunctionInvention) Validate() error

type FunctionsInventionsResponseUnaryObject ¶ 

type FunctionsInventionsResponseUnaryObject struct {
	AlphaScalarFunctionInvention *string `validate:"omitempty,oneof=alpha.scalar.function.invention"`
	AlphaVectorFunctionInvention *string `validate:"omitempty,oneof=alpha.vector.function.invention"`
}

func (FunctionsInventionsResponseUnaryObject) MarshalJSON ¶ 

func (v FunctionsInventionsResponseUnaryObject) MarshalJSON() ([]byte, error)

func (FunctionsInventionsResponseUnaryObject) SchemaTitle ¶ 

func (FunctionsInventionsResponseUnaryObject) SchemaTitle() string

func (*FunctionsInventionsResponseUnaryObject) UnmarshalJSON ¶ 

func (v *FunctionsInventionsResponseUnaryObject) UnmarshalJSON(data []byte) error

func (FunctionsInventionsResponseUnaryObject) Validate ¶ 

func (v FunctionsInventionsResponseUnaryObject) Validate() error

type FunctionsInventionsScalarBranchTaskObject ¶ 

type FunctionsInventionsScalarBranchTaskObject struct {
	Task string `json:"task"`
}

Schema for AppendTask on scalar branch functions. Takes a `task` property: a JSON string conforming to `functions.alpha_scalar.PartialPlaceholderBranchTaskExpression`.

func (FunctionsInventionsScalarBranchTaskObject) SchemaTitle ¶ 

func (FunctionsInventionsScalarBranchTaskObject) SchemaTitle() string

func (*FunctionsInventionsScalarBranchTaskObject) UnmarshalJSON ¶ 

func (v *FunctionsInventionsScalarBranchTaskObject) UnmarshalJSON(data []byte) error

func (FunctionsInventionsScalarBranchTaskObject) Validate ¶ 

func (v FunctionsInventionsScalarBranchTaskObject) Validate() error

type FunctionsInventionsScalarInputSchemaObject ¶ 

type FunctionsInventionsScalarInputSchemaObject struct {
	Schema string `json:"schema"`
}

Schema for WriteInputSchema on scalar functions. Takes a `schema` property: a JSON string conforming to `functions.expression.ObjectInputSchema`.

func (FunctionsInventionsScalarInputSchemaObject) SchemaTitle ¶ 

func (FunctionsInventionsScalarInputSchemaObject) SchemaTitle() string

func (*FunctionsInventionsScalarInputSchemaObject) UnmarshalJSON ¶ 

func (v *FunctionsInventionsScalarInputSchemaObject) UnmarshalJSON(data []byte) error

func (FunctionsInventionsScalarInputSchemaObject) Validate ¶ 

func (v FunctionsInventionsScalarInputSchemaObject) Validate() error

type FunctionsInventionsScalarLeafTaskObject ¶ 

type FunctionsInventionsScalarLeafTaskObject struct {
	Task string `json:"task"`
}

Schema for AppendTask on scalar leaf functions. Takes a `task` property: a JSON string conforming to `functions.alpha_scalar.LeafTaskExpression`.

func (FunctionsInventionsScalarLeafTaskObject) SchemaTitle ¶ 

func (FunctionsInventionsScalarLeafTaskObject) SchemaTitle() string

func (*FunctionsInventionsScalarLeafTaskObject) UnmarshalJSON ¶ 

func (v *FunctionsInventionsScalarLeafTaskObject) UnmarshalJSON(data []byte) error

func (FunctionsInventionsScalarLeafTaskObject) Validate ¶ 

func (v FunctionsInventionsScalarLeafTaskObject) Validate() error

type FunctionsInventionsStateAlphaScalarBranchState ¶ 

type FunctionsInventionsStateAlphaScalarBranchState struct {
	Depth          uint64                                      `json:"depth" validate:"min=0,max=18446744073709551615"`
	Description    *string                                     `json:"description,omitempty"`
	Essay          *string                                     `json:"essay,omitempty"`
	EssayTasks     *string                                     `json:"essay_tasks,omitempty"`
	InputSchema    *FunctionsExpressionObjectInputSchema       `json:"input_schema,omitempty"`
	MaxBranchWidth uint64                                      `json:"max_branch_width" validate:"min=0,max=18446744073709551615"`
	MaxLeafWidth   uint64                                      `json:"max_leaf_width" validate:"min=0,max=18446744073709551615"`
	MinBranchWidth uint64                                      `json:"min_branch_width" validate:"min=0,max=18446744073709551615"`
	MinLeafWidth   uint64                                      `json:"min_leaf_width" validate:"min=0,max=18446744073709551615"`
	Name           string                                      `json:"name"`
	Readme         *string                                     `json:"readme,omitempty"`
	Spec           string                                      `json:"spec"`
	Tasks          *[]FunctionsAlphaScalarBranchTaskExpression `json:"tasks,omitempty"`
	TasksLength    *uint64                                     `json:"tasks_length,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
}

func (FunctionsInventionsStateAlphaScalarBranchState) SchemaTitle ¶ 

func (FunctionsInventionsStateAlphaScalarBranchState) SchemaTitle() string

func (*FunctionsInventionsStateAlphaScalarBranchState) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateAlphaScalarBranchState) UnmarshalJSON(data []byte) error

func (FunctionsInventionsStateAlphaScalarBranchState) Validate ¶ 

func (v FunctionsInventionsStateAlphaScalarBranchState) Validate() error

type FunctionsInventionsStateAlphaScalarLeafState ¶ 

type FunctionsInventionsStateAlphaScalarLeafState struct {
	Depth          uint64                                    `json:"depth" validate:"min=0,max=18446744073709551615"`
	Description    *string                                   `json:"description,omitempty"`
	Essay          *string                                   `json:"essay,omitempty"`
	EssayTasks     *string                                   `json:"essay_tasks,omitempty"`
	InputSchema    *FunctionsExpressionObjectInputSchema     `json:"input_schema,omitempty"`
	MaxBranchWidth uint64                                    `json:"max_branch_width" validate:"min=0,max=18446744073709551615"`
	MaxLeafWidth   uint64                                    `json:"max_leaf_width" validate:"min=0,max=18446744073709551615"`
	MinBranchWidth uint64                                    `json:"min_branch_width" validate:"min=0,max=18446744073709551615"`
	MinLeafWidth   uint64                                    `json:"min_leaf_width" validate:"min=0,max=18446744073709551615"`
	Name           string                                    `json:"name"`
	Readme         *string                                   `json:"readme,omitempty"`
	Spec           string                                    `json:"spec"`
	Tasks          *[]FunctionsAlphaScalarLeafTaskExpression `json:"tasks,omitempty"`
	TasksLength    *uint64                                   `json:"tasks_length,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
}

func (FunctionsInventionsStateAlphaScalarLeafState) SchemaTitle ¶ 

func (FunctionsInventionsStateAlphaScalarLeafState) SchemaTitle() string

func (*FunctionsInventionsStateAlphaScalarLeafState) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateAlphaScalarLeafState) UnmarshalJSON(data []byte) error

func (FunctionsInventionsStateAlphaScalarLeafState) Validate ¶ 

func (v FunctionsInventionsStateAlphaScalarLeafState) Validate() error

type FunctionsInventionsStateAlphaScalarState ¶ 

type FunctionsInventionsStateAlphaScalarState struct {
	Depth          uint64                                `json:"depth" validate:"min=0,max=18446744073709551615"`
	InputSchema    *FunctionsExpressionObjectInputSchema `json:"input_schema,omitempty"`
	MaxBranchWidth uint64                                `json:"max_branch_width" validate:"min=0,max=18446744073709551615"`
	MaxLeafWidth   uint64                                `json:"max_leaf_width" validate:"min=0,max=18446744073709551615"`
	MinBranchWidth uint64                                `json:"min_branch_width" validate:"min=0,max=18446744073709551615"`
	MinLeafWidth   uint64                                `json:"min_leaf_width" validate:"min=0,max=18446744073709551615"`
	Name           string                                `json:"name"`
	Spec           string                                `json:"spec"`
}

func (FunctionsInventionsStateAlphaScalarState) SchemaTitle ¶ 

func (FunctionsInventionsStateAlphaScalarState) SchemaTitle() string

func (*FunctionsInventionsStateAlphaScalarState) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateAlphaScalarState) UnmarshalJSON(data []byte) error

func (FunctionsInventionsStateAlphaScalarState) Validate ¶ 

func (v FunctionsInventionsStateAlphaScalarState) Validate() error

type FunctionsInventionsStateAlphaVectorBranchState ¶ 

type FunctionsInventionsStateAlphaVectorBranchState struct {
	Depth          uint64                                                   `json:"depth" validate:"min=0,max=18446744073709551615"`
	Description    *string                                                  `json:"description,omitempty"`
	Essay          *string                                                  `json:"essay,omitempty"`
	EssayTasks     *string                                                  `json:"essay_tasks,omitempty"`
	InputSchema    *FunctionsAlphaVectorExpressionVectorFunctionInputSchema `json:"input_schema,omitempty"`
	MaxBranchWidth uint64                                                   `json:"max_branch_width" validate:"min=0,max=18446744073709551615"`
	MaxLeafWidth   uint64                                                   `json:"max_leaf_width" validate:"min=0,max=18446744073709551615"`
	MinBranchWidth uint64                                                   `json:"min_branch_width" validate:"min=0,max=18446744073709551615"`
	MinLeafWidth   uint64                                                   `json:"min_leaf_width" validate:"min=0,max=18446744073709551615"`
	Name           string                                                   `json:"name"`
	Readme         *string                                                  `json:"readme,omitempty"`
	Spec           string                                                   `json:"spec"`
	Tasks          *[]FunctionsAlphaVectorBranchTaskExpression              `json:"tasks,omitempty"`
	TasksLength    *uint64                                                  `json:"tasks_length,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
}

func (FunctionsInventionsStateAlphaVectorBranchState) SchemaTitle ¶ 

func (FunctionsInventionsStateAlphaVectorBranchState) SchemaTitle() string

func (*FunctionsInventionsStateAlphaVectorBranchState) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateAlphaVectorBranchState) UnmarshalJSON(data []byte) error

func (FunctionsInventionsStateAlphaVectorBranchState) Validate ¶ 

func (v FunctionsInventionsStateAlphaVectorBranchState) Validate() error

type FunctionsInventionsStateAlphaVectorLeafState ¶ 

type FunctionsInventionsStateAlphaVectorLeafState struct {
	Depth          uint64                                                   `json:"depth" validate:"min=0,max=18446744073709551615"`
	Description    *string                                                  `json:"description,omitempty"`
	Essay          *string                                                  `json:"essay,omitempty"`
	EssayTasks     *string                                                  `json:"essay_tasks,omitempty"`
	InputSchema    *FunctionsAlphaVectorExpressionVectorFunctionInputSchema `json:"input_schema,omitempty"`
	MaxBranchWidth uint64                                                   `json:"max_branch_width" validate:"min=0,max=18446744073709551615"`
	MaxLeafWidth   uint64                                                   `json:"max_leaf_width" validate:"min=0,max=18446744073709551615"`
	MinBranchWidth uint64                                                   `json:"min_branch_width" validate:"min=0,max=18446744073709551615"`
	MinLeafWidth   uint64                                                   `json:"min_leaf_width" validate:"min=0,max=18446744073709551615"`
	Name           string                                                   `json:"name"`
	Readme         *string                                                  `json:"readme,omitempty"`
	Spec           string                                                   `json:"spec"`
	Tasks          *[]FunctionsAlphaVectorLeafTaskExpression                `json:"tasks,omitempty"`
	TasksLength    *uint64                                                  `json:"tasks_length,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
}

func (FunctionsInventionsStateAlphaVectorLeafState) SchemaTitle ¶ 

func (FunctionsInventionsStateAlphaVectorLeafState) SchemaTitle() string

func (*FunctionsInventionsStateAlphaVectorLeafState) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateAlphaVectorLeafState) UnmarshalJSON(data []byte) error

func (FunctionsInventionsStateAlphaVectorLeafState) Validate ¶ 

func (v FunctionsInventionsStateAlphaVectorLeafState) Validate() error

type FunctionsInventionsStateAlphaVectorState ¶ 

type FunctionsInventionsStateAlphaVectorState struct {
	Depth          uint64                                                   `json:"depth" validate:"min=0,max=18446744073709551615"`
	InputSchema    *FunctionsAlphaVectorExpressionVectorFunctionInputSchema `json:"input_schema,omitempty"`
	MaxBranchWidth uint64                                                   `json:"max_branch_width" validate:"min=0,max=18446744073709551615"`
	MaxLeafWidth   uint64                                                   `json:"max_leaf_width" validate:"min=0,max=18446744073709551615"`
	MinBranchWidth uint64                                                   `json:"min_branch_width" validate:"min=0,max=18446744073709551615"`
	MinLeafWidth   uint64                                                   `json:"min_leaf_width" validate:"min=0,max=18446744073709551615"`
	Name           string                                                   `json:"name"`
	Spec           string                                                   `json:"spec"`
}

func (FunctionsInventionsStateAlphaVectorState) SchemaTitle ¶ 

func (FunctionsInventionsStateAlphaVectorState) SchemaTitle() string

func (*FunctionsInventionsStateAlphaVectorState) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateAlphaVectorState) UnmarshalJSON(data []byte) error

func (FunctionsInventionsStateAlphaVectorState) Validate ¶ 

func (v FunctionsInventionsStateAlphaVectorState) Validate() error

type FunctionsInventionsStateGetFunctionInventionStateResponse ¶ 

type FunctionsInventionsStateGetFunctionInventionStateResponse struct {
	RemotePath
}

Response from retrieving a function invention state.

func FunctionsInventionsStateGetFunctionInventionState ¶ 

func FunctionsInventionsStateGetFunctionInventionState(ctx context.Context, c *Client, params RemotePathCommitOptional) (*FunctionsInventionsStateGetFunctionInventionStateResponse, error)

func (FunctionsInventionsStateGetFunctionInventionStateResponse) SchemaTitle ¶ 

func (FunctionsInventionsStateGetFunctionInventionStateResponse) SchemaTitle() string

func (FunctionsInventionsStateGetFunctionInventionStateResponse) Validate ¶ 

func (v FunctionsInventionsStateGetFunctionInventionStateResponse) Validate() error

type FunctionsInventionsStateInputSchema ¶ 

type FunctionsInventionsStateInputSchema struct {
	ScalarFunctionInputSchema *FunctionsInventionsStateInputSchemaScalarFunctionInputSchema
	VectorFunctionInputSchema *FunctionsInventionsStateInputSchemaVectorFunctionInputSchema
}

Tagged union of input schema types for invention state serialization. The actual schema is nested under a `schema` key to avoid conflicts with the `type` tag field (since ObjectInputSchema has its own `type` field).

func (FunctionsInventionsStateInputSchema) MarshalJSON ¶ 

func (v FunctionsInventionsStateInputSchema) MarshalJSON() ([]byte, error)

func (FunctionsInventionsStateInputSchema) SchemaTitle ¶ 

func (FunctionsInventionsStateInputSchema) SchemaTitle() string

func (*FunctionsInventionsStateInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateInputSchema) UnmarshalJSON(data []byte) error

func (FunctionsInventionsStateInputSchema) Validate ¶ 

func (v FunctionsInventionsStateInputSchema) Validate() error

type FunctionsInventionsStateInputSchemaScalarFunctionInputSchema ¶ 

type FunctionsInventionsStateInputSchemaScalarFunctionInputSchema struct {
	Schema FunctionsExpressionObjectInputSchema `json:"schema"`
	Type   string                               `json:"type" validate:"oneof=alpha.scalar.function"`
}

func (FunctionsInventionsStateInputSchemaScalarFunctionInputSchema) SchemaVariantTitle ¶ 

func (FunctionsInventionsStateInputSchemaScalarFunctionInputSchema) SchemaVariantTitle() string

func (*FunctionsInventionsStateInputSchemaScalarFunctionInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateInputSchemaScalarFunctionInputSchema) UnmarshalJSON(data []byte) error

type FunctionsInventionsStateInputSchemaVectorFunctionInputSchema ¶ 

type FunctionsInventionsStateInputSchemaVectorFunctionInputSchema struct {
	Schema FunctionsAlphaVectorExpressionVectorFunctionInputSchema `json:"schema"`
	Type   string                                                  `json:"type" validate:"oneof=alpha.vector.function"`
}

func (FunctionsInventionsStateInputSchemaVectorFunctionInputSchema) SchemaVariantTitle ¶ 

func (FunctionsInventionsStateInputSchemaVectorFunctionInputSchema) SchemaVariantTitle() string

func (*FunctionsInventionsStateInputSchemaVectorFunctionInputSchema) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateInputSchemaVectorFunctionInputSchema) UnmarshalJSON(data []byte) error

type FunctionsInventionsStateParams ¶ 

type FunctionsInventionsStateParams struct {
	Depth          uint64 `json:"depth" validate:"min=0,max=18446744073709551615"`
	MaxBranchWidth uint64 `json:"max_branch_width" validate:"min=0,max=18446744073709551615"`
	MaxLeafWidth   uint64 `json:"max_leaf_width" validate:"min=0,max=18446744073709551615"`
	MinBranchWidth uint64 `json:"min_branch_width" validate:"min=0,max=18446744073709551615"`
	MinLeafWidth   uint64 `json:"min_leaf_width" validate:"min=0,max=18446744073709551615"`
	Name           string `json:"name"`
	Spec           string `json:"spec"`
}

func (FunctionsInventionsStateParams) SchemaTitle ¶ 

func (FunctionsInventionsStateParams) SchemaTitle() string

func (*FunctionsInventionsStateParams) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateParams) UnmarshalJSON(data []byte) error

func (FunctionsInventionsStateParams) Validate ¶ 

func (v FunctionsInventionsStateParams) Validate() error

type FunctionsInventionsStateParamsState ¶ 

type FunctionsInventionsStateParamsState struct {
	AlphaScalarBranch *FunctionsInventionsStateParamsStateAlphaScalarBranch
	AlphaScalarLeaf   *FunctionsInventionsStateParamsStateAlphaScalarLeaf
	AlphaVectorBranch *FunctionsInventionsStateParamsStateAlphaVectorBranch
	AlphaVectorLeaf   *FunctionsInventionsStateParamsStateAlphaVectorLeaf
	AlphaScalar       *FunctionsInventionsStateParamsStateAlphaScalar
	AlphaVector       *FunctionsInventionsStateParamsStateAlphaVector
}

func (FunctionsInventionsStateParamsState) MarshalJSON ¶ 

func (v FunctionsInventionsStateParamsState) MarshalJSON() ([]byte, error)

func (FunctionsInventionsStateParamsState) SchemaTitle ¶ 

func (FunctionsInventionsStateParamsState) SchemaTitle() string

func (*FunctionsInventionsStateParamsState) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateParamsState) UnmarshalJSON(data []byte) error

func (FunctionsInventionsStateParamsState) Validate ¶ 

func (v FunctionsInventionsStateParamsState) Validate() error

type FunctionsInventionsStateParamsStateAlphaScalar ¶ 

type FunctionsInventionsStateParamsStateAlphaScalar struct {
	FunctionsInventionsStateAlphaScalarState
	Type string `json:"type" validate:"oneof=alpha.scalar.function"`
}

func (FunctionsInventionsStateParamsStateAlphaScalar) MarshalJSON ¶ 

func (v FunctionsInventionsStateParamsStateAlphaScalar) MarshalJSON() ([]byte, error)

func (FunctionsInventionsStateParamsStateAlphaScalar) SchemaVariantTitle ¶ 

func (FunctionsInventionsStateParamsStateAlphaScalar) SchemaVariantTitle() string

func (*FunctionsInventionsStateParamsStateAlphaScalar) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateParamsStateAlphaScalar) UnmarshalJSON(data []byte) error

type FunctionsInventionsStateParamsStateAlphaScalarBranch ¶ 

type FunctionsInventionsStateParamsStateAlphaScalarBranch struct {
	FunctionsInventionsStateAlphaScalarBranchState
	Type string `json:"type" validate:"oneof=alpha.scalar.branch.function"`
}

func (FunctionsInventionsStateParamsStateAlphaScalarBranch) MarshalJSON ¶ 

func (v FunctionsInventionsStateParamsStateAlphaScalarBranch) MarshalJSON() ([]byte, error)

func (FunctionsInventionsStateParamsStateAlphaScalarBranch) SchemaVariantTitle ¶ 

func (FunctionsInventionsStateParamsStateAlphaScalarBranch) SchemaVariantTitle() string

func (*FunctionsInventionsStateParamsStateAlphaScalarBranch) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateParamsStateAlphaScalarBranch) UnmarshalJSON(data []byte) error

type FunctionsInventionsStateParamsStateAlphaScalarLeaf ¶ 

type FunctionsInventionsStateParamsStateAlphaScalarLeaf struct {
	FunctionsInventionsStateAlphaScalarLeafState
	Type string `json:"type" validate:"oneof=alpha.scalar.leaf.function"`
}

func (FunctionsInventionsStateParamsStateAlphaScalarLeaf) MarshalJSON ¶ 

func (v FunctionsInventionsStateParamsStateAlphaScalarLeaf) MarshalJSON() ([]byte, error)

func (FunctionsInventionsStateParamsStateAlphaScalarLeaf) SchemaVariantTitle ¶ 

func (FunctionsInventionsStateParamsStateAlphaScalarLeaf) SchemaVariantTitle() string

func (*FunctionsInventionsStateParamsStateAlphaScalarLeaf) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateParamsStateAlphaScalarLeaf) UnmarshalJSON(data []byte) error

type FunctionsInventionsStateParamsStateAlphaVector ¶ 

type FunctionsInventionsStateParamsStateAlphaVector struct {
	FunctionsInventionsStateAlphaVectorState
	Type string `json:"type" validate:"oneof=alpha.vector.function"`
}

func (FunctionsInventionsStateParamsStateAlphaVector) MarshalJSON ¶ 

func (v FunctionsInventionsStateParamsStateAlphaVector) MarshalJSON() ([]byte, error)

func (FunctionsInventionsStateParamsStateAlphaVector) SchemaVariantTitle ¶ 

func (FunctionsInventionsStateParamsStateAlphaVector) SchemaVariantTitle() string

func (*FunctionsInventionsStateParamsStateAlphaVector) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateParamsStateAlphaVector) UnmarshalJSON(data []byte) error

type FunctionsInventionsStateParamsStateAlphaVectorBranch ¶ 

type FunctionsInventionsStateParamsStateAlphaVectorBranch struct {
	FunctionsInventionsStateAlphaVectorBranchState
	Type string `json:"type" validate:"oneof=alpha.vector.branch.function"`
}

func (FunctionsInventionsStateParamsStateAlphaVectorBranch) MarshalJSON ¶ 

func (v FunctionsInventionsStateParamsStateAlphaVectorBranch) MarshalJSON() ([]byte, error)

func (FunctionsInventionsStateParamsStateAlphaVectorBranch) SchemaVariantTitle ¶ 

func (FunctionsInventionsStateParamsStateAlphaVectorBranch) SchemaVariantTitle() string

func (*FunctionsInventionsStateParamsStateAlphaVectorBranch) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateParamsStateAlphaVectorBranch) UnmarshalJSON(data []byte) error

type FunctionsInventionsStateParamsStateAlphaVectorLeaf ¶ 

type FunctionsInventionsStateParamsStateAlphaVectorLeaf struct {
	FunctionsInventionsStateAlphaVectorLeafState
	Type string `json:"type" validate:"oneof=alpha.vector.leaf.function"`
}

func (FunctionsInventionsStateParamsStateAlphaVectorLeaf) MarshalJSON ¶ 

func (v FunctionsInventionsStateParamsStateAlphaVectorLeaf) MarshalJSON() ([]byte, error)

func (FunctionsInventionsStateParamsStateAlphaVectorLeaf) SchemaVariantTitle ¶ 

func (FunctionsInventionsStateParamsStateAlphaVectorLeaf) SchemaVariantTitle() string

func (*FunctionsInventionsStateParamsStateAlphaVectorLeaf) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateParamsStateAlphaVectorLeaf) UnmarshalJSON(data []byte) error

type FunctionsInventionsStateParamsStateOrRemoteCommitOptional ¶ 

type FunctionsInventionsStateParamsStateOrRemoteCommitOptional struct {
	ParamsState *FunctionsInventionsStateParamsState
	Remote      *RemotePathCommitOptional
}

A state specification that is either an inline ParamsState definition or a remote path reference.

func (FunctionsInventionsStateParamsStateOrRemoteCommitOptional) MarshalJSON ¶ 

func (v FunctionsInventionsStateParamsStateOrRemoteCommitOptional) MarshalJSON() ([]byte, error)

func (FunctionsInventionsStateParamsStateOrRemoteCommitOptional) SchemaTitle ¶ 

func (FunctionsInventionsStateParamsStateOrRemoteCommitOptional) SchemaTitle() string

func (*FunctionsInventionsStateParamsStateOrRemoteCommitOptional) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateParamsStateOrRemoteCommitOptional) UnmarshalJSON(data []byte) error

func (FunctionsInventionsStateParamsStateOrRemoteCommitOptional) Validate ¶ 

func (v FunctionsInventionsStateParamsStateOrRemoteCommitOptional) Validate() error

type FunctionsInventionsStateState ¶ 

type FunctionsInventionsStateState struct {
	AlphaScalarBranch *FunctionsInventionsStateStateAlphaScalarBranch
	AlphaScalarLeaf   *FunctionsInventionsStateStateAlphaScalarLeaf
	AlphaVectorBranch *FunctionsInventionsStateStateAlphaVectorBranch
	AlphaVectorLeaf   *FunctionsInventionsStateStateAlphaVectorLeaf
}

func (FunctionsInventionsStateState) MarshalJSON ¶ 

func (v FunctionsInventionsStateState) MarshalJSON() ([]byte, error)

func (FunctionsInventionsStateState) SchemaTitle ¶ 

func (FunctionsInventionsStateState) SchemaTitle() string

func (*FunctionsInventionsStateState) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateState) UnmarshalJSON(data []byte) error

func (FunctionsInventionsStateState) Validate ¶ 

func (v FunctionsInventionsStateState) Validate() error

type FunctionsInventionsStateStateAlphaScalarBranch ¶ 

type FunctionsInventionsStateStateAlphaScalarBranch struct {
	FunctionsInventionsStateAlphaScalarBranchState
	Type string `json:"type" validate:"oneof=alpha.scalar.branch.function"`
}

func (FunctionsInventionsStateStateAlphaScalarBranch) MarshalJSON ¶ 

func (v FunctionsInventionsStateStateAlphaScalarBranch) MarshalJSON() ([]byte, error)

func (FunctionsInventionsStateStateAlphaScalarBranch) SchemaVariantTitle ¶ 

func (FunctionsInventionsStateStateAlphaScalarBranch) SchemaVariantTitle() string

func (*FunctionsInventionsStateStateAlphaScalarBranch) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateStateAlphaScalarBranch) UnmarshalJSON(data []byte) error

type FunctionsInventionsStateStateAlphaScalarLeaf ¶ 

type FunctionsInventionsStateStateAlphaScalarLeaf struct {
	FunctionsInventionsStateAlphaScalarLeafState
	Type string `json:"type" validate:"oneof=alpha.scalar.leaf.function"`
}

func (FunctionsInventionsStateStateAlphaScalarLeaf) MarshalJSON ¶ 

func (v FunctionsInventionsStateStateAlphaScalarLeaf) MarshalJSON() ([]byte, error)

func (FunctionsInventionsStateStateAlphaScalarLeaf) SchemaVariantTitle ¶ 

func (FunctionsInventionsStateStateAlphaScalarLeaf) SchemaVariantTitle() string

func (*FunctionsInventionsStateStateAlphaScalarLeaf) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateStateAlphaScalarLeaf) UnmarshalJSON(data []byte) error

type FunctionsInventionsStateStateAlphaVectorBranch ¶ 

type FunctionsInventionsStateStateAlphaVectorBranch struct {
	FunctionsInventionsStateAlphaVectorBranchState
	Type string `json:"type" validate:"oneof=alpha.vector.branch.function"`
}

func (FunctionsInventionsStateStateAlphaVectorBranch) MarshalJSON ¶ 

func (v FunctionsInventionsStateStateAlphaVectorBranch) MarshalJSON() ([]byte, error)

func (FunctionsInventionsStateStateAlphaVectorBranch) SchemaVariantTitle ¶ 

func (FunctionsInventionsStateStateAlphaVectorBranch) SchemaVariantTitle() string

func (*FunctionsInventionsStateStateAlphaVectorBranch) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateStateAlphaVectorBranch) UnmarshalJSON(data []byte) error

type FunctionsInventionsStateStateAlphaVectorLeaf ¶ 

type FunctionsInventionsStateStateAlphaVectorLeaf struct {
	FunctionsInventionsStateAlphaVectorLeafState
	Type string `json:"type" validate:"oneof=alpha.vector.leaf.function"`
}

func (FunctionsInventionsStateStateAlphaVectorLeaf) MarshalJSON ¶ 

func (v FunctionsInventionsStateStateAlphaVectorLeaf) MarshalJSON() ([]byte, error)

func (FunctionsInventionsStateStateAlphaVectorLeaf) SchemaVariantTitle ¶ 

func (FunctionsInventionsStateStateAlphaVectorLeaf) SchemaVariantTitle() string

func (*FunctionsInventionsStateStateAlphaVectorLeaf) UnmarshalJSON ¶ 

func (v *FunctionsInventionsStateStateAlphaVectorLeaf) UnmarshalJSON(data []byte) error

type FunctionsInventionsTasksLengthObject ¶ 

type FunctionsInventionsTasksLengthObject struct {
	TasksLength uint64 `json:"tasks_length" validate:"min=0,max=18446744073709551615"`
}

func (FunctionsInventionsTasksLengthObject) SchemaTitle ¶ 

func (FunctionsInventionsTasksLengthObject) SchemaTitle() string

func (*FunctionsInventionsTasksLengthObject) UnmarshalJSON ¶ 

func (v *FunctionsInventionsTasksLengthObject) UnmarshalJSON(data []byte) error

func (FunctionsInventionsTasksLengthObject) Validate ¶ 

func (v FunctionsInventionsTasksLengthObject) Validate() error

type FunctionsInventionsVectorBranchTaskObject ¶ 

type FunctionsInventionsVectorBranchTaskObject struct {
	Task string `json:"task"`
}

Schema for AppendTask on vector branch functions. Takes a `task` property: a JSON string conforming to `functions.alpha_vector.PartialPlaceholderBranchTaskExpression`.

func (FunctionsInventionsVectorBranchTaskObject) SchemaTitle ¶ 

func (FunctionsInventionsVectorBranchTaskObject) SchemaTitle() string

func (*FunctionsInventionsVectorBranchTaskObject) UnmarshalJSON ¶ 

func (v *FunctionsInventionsVectorBranchTaskObject) UnmarshalJSON(data []byte) error

func (FunctionsInventionsVectorBranchTaskObject) Validate ¶ 

func (v FunctionsInventionsVectorBranchTaskObject) Validate() error

type FunctionsInventionsVectorInputSchemaObject ¶ 

type FunctionsInventionsVectorInputSchemaObject struct {
	Schema string `json:"schema"`
}

Schema for WriteInputSchema on vector functions. Takes a `schema` property: a JSON string conforming to `functions.alpha_vector.expression.VectorFunctionInputSchema`.

func (FunctionsInventionsVectorInputSchemaObject) SchemaTitle ¶ 

func (FunctionsInventionsVectorInputSchemaObject) SchemaTitle() string

func (*FunctionsInventionsVectorInputSchemaObject) UnmarshalJSON ¶ 

func (v *FunctionsInventionsVectorInputSchemaObject) UnmarshalJSON(data []byte) error

func (FunctionsInventionsVectorInputSchemaObject) Validate ¶ 

func (v FunctionsInventionsVectorInputSchemaObject) Validate() error

type FunctionsInventionsVectorLeafTaskObject ¶ 

type FunctionsInventionsVectorLeafTaskObject struct {
	Task string `json:"task"`
}

Schema for AppendTask on vector leaf functions. Takes a `task` property: a JSON string conforming to `functions.alpha_vector.LeafTaskExpression`.

func (FunctionsInventionsVectorLeafTaskObject) SchemaTitle ¶ 

func (FunctionsInventionsVectorLeafTaskObject) SchemaTitle() string

func (*FunctionsInventionsVectorLeafTaskObject) UnmarshalJSON ¶ 

func (v *FunctionsInventionsVectorLeafTaskObject) UnmarshalJSON(data []byte) error

func (FunctionsInventionsVectorLeafTaskObject) Validate ¶ 

func (v FunctionsInventionsVectorLeafTaskObject) Validate() error

type FunctionsListFunctionProfilePairItem ¶ 

type FunctionsListFunctionProfilePairItem struct {
	// The function.
	Function RemotePath `json:"function"`
	// The profile.
	Profile RemotePath `json:"profile"`
}

A function-profile pair in a list response.

func (FunctionsListFunctionProfilePairItem) SchemaTitle ¶ 

func (FunctionsListFunctionProfilePairItem) SchemaTitle() string

func (*FunctionsListFunctionProfilePairItem) UnmarshalJSON ¶ 

func (v *FunctionsListFunctionProfilePairItem) UnmarshalJSON(data []byte) error

func (FunctionsListFunctionProfilePairItem) Validate ¶ 

func (v FunctionsListFunctionProfilePairItem) Validate() error

type FunctionsListFunctionProfilePairResponse ¶ 

type FunctionsListFunctionProfilePairResponse struct {
	// List of available function-profile pairs.
	Data []FunctionsListFunctionProfilePairItem `json:"data"`
}

Response from listing function-profile pairs.

func FunctionsListFunctionProfilePairs ¶ 

func FunctionsListFunctionProfilePairs(ctx context.Context, c *Client, params FunctionsListFunctionProfilePairsRequest) (*FunctionsListFunctionProfilePairResponse, error)

func (FunctionsListFunctionProfilePairResponse) SchemaTitle ¶ 

func (FunctionsListFunctionProfilePairResponse) SchemaTitle() string

func (*FunctionsListFunctionProfilePairResponse) UnmarshalJSON ¶ 

func (v *FunctionsListFunctionProfilePairResponse) UnmarshalJSON(data []byte) error

func (FunctionsListFunctionProfilePairResponse) Validate ¶ 

func (v FunctionsListFunctionProfilePairResponse) Validate() error

type FunctionsListFunctionProfilePairsRequest ¶ 

type FunctionsListFunctionProfilePairsRequest struct {
	// Optional source filter for listing function-profile pairs.
	Source *FunctionsListFunctionProfilePairsSource `json:"source,omitempty"`
}

Query parameters for the list function-profile pairs endpoint.

func (FunctionsListFunctionProfilePairsRequest) SchemaTitle ¶ 

func (FunctionsListFunctionProfilePairsRequest) SchemaTitle() string

func (FunctionsListFunctionProfilePairsRequest) Validate ¶ 

func (v FunctionsListFunctionProfilePairsRequest) Validate() error

type FunctionsListFunctionProfilePairsSource ¶ 

type FunctionsListFunctionProfilePairsSource struct {
	Objectiveai string `validate:"omitempty,oneof=objectiveai"`
}

Source filter for listing function-profile pairs.

func (FunctionsListFunctionProfilePairsSource) MarshalJSON ¶ 

func (v FunctionsListFunctionProfilePairsSource) MarshalJSON() ([]byte, error)

func (FunctionsListFunctionProfilePairsSource) SchemaTitle ¶ 

func (FunctionsListFunctionProfilePairsSource) SchemaTitle() string

func (*FunctionsListFunctionProfilePairsSource) UnmarshalJSON ¶ 

func (v *FunctionsListFunctionProfilePairsSource) UnmarshalJSON(data []byte) error

func (FunctionsListFunctionProfilePairsSource) Validate ¶ 

func (v FunctionsListFunctionProfilePairsSource) Validate() error

type FunctionsListFunctionResponse ¶ 

type FunctionsListFunctionResponse struct {
	// List of available functions.
	Data []RemotePath `json:"data"`
}

Response from listing functions.

func FunctionsListFunctions ¶ 

func FunctionsListFunctions(ctx context.Context, c *Client, params FunctionsListFunctionsRequest) (*FunctionsListFunctionResponse, error)

func (FunctionsListFunctionResponse) SchemaTitle ¶ 

func (FunctionsListFunctionResponse) SchemaTitle() string

func (*FunctionsListFunctionResponse) UnmarshalJSON ¶ 

func (v *FunctionsListFunctionResponse) UnmarshalJSON(data []byte) error

func (FunctionsListFunctionResponse) Validate ¶ 

func (v FunctionsListFunctionResponse) Validate() error

type FunctionsListFunctionsRequest ¶ 

type FunctionsListFunctionsRequest struct {
	// Optional source filter for listing functions.
	Source *FunctionsListFunctionsSource `json:"source,omitempty"`
}

Query parameters for the list functions endpoint.

func (FunctionsListFunctionsRequest) SchemaTitle ¶ 

func (FunctionsListFunctionsRequest) SchemaTitle() string

func (FunctionsListFunctionsRequest) Validate ¶ 

func (v FunctionsListFunctionsRequest) Validate() error

type FunctionsListFunctionsSource ¶ 

type FunctionsListFunctionsSource struct {
	All         *string `validate:"omitempty,oneof=all"`
	Mock        *string `validate:"omitempty,oneof=mock"`
	Filesystem  *string `validate:"omitempty,oneof=filesystem"`
	Objectiveai *string `validate:"omitempty,oneof=objectiveai"`
}

Source filter for listing functions.

func (FunctionsListFunctionsSource) MarshalJSON ¶ 

func (v FunctionsListFunctionsSource) MarshalJSON() ([]byte, error)

func (FunctionsListFunctionsSource) SchemaTitle ¶ 

func (FunctionsListFunctionsSource) SchemaTitle() string

func (*FunctionsListFunctionsSource) UnmarshalJSON ¶ 

func (v *FunctionsListFunctionsSource) UnmarshalJSON(data []byte) error

func (FunctionsListFunctionsSource) Validate ¶ 

func (v FunctionsListFunctionsSource) Validate() error

type FunctionsPlaceholderScalarFunctionTask ¶ 

type FunctionsPlaceholderScalarFunctionTask struct {
	// The resolved input.
	Input FunctionsExpressionInputValue `json:"input"`
	// JSON Schema defining the expected input structure.
	InputSchema FunctionsExpressionInputSchema `json:"input_schema"`
	// Expression to transform the fixed 0.5 output.
	Output FunctionsExpressionExpression `json:"output"`
}

A compiled placeholder scalar function task.

Always produces `Scalar(0.5)` before the output expression is applied.

func (FunctionsPlaceholderScalarFunctionTask) SchemaTitle ¶ 

func (FunctionsPlaceholderScalarFunctionTask) SchemaTitle() string

func (*FunctionsPlaceholderScalarFunctionTask) UnmarshalJSON ¶ 

func (v *FunctionsPlaceholderScalarFunctionTask) UnmarshalJSON(data []byte) error

func (FunctionsPlaceholderScalarFunctionTask) Validate ¶ 

func (v FunctionsPlaceholderScalarFunctionTask) Validate() error

type FunctionsPlaceholderScalarFunctionTaskExpression ¶ 

type FunctionsPlaceholderScalarFunctionTaskExpression struct {
	// Expression for the input to pass to the placeholder function.
	// Receives: `input`, `map` (if mapped).
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Input FunctionsPlaceholderScalarFunctionTaskExpressionInput `json:"input"`
	// JSON Schema defining the expected input structure.
	InputSchema FunctionsExpressionInputSchema `json:"input_schema"`
	// Expression that evaluates to the number of mapped task instances.
	// Each instance receives `map` as an integer index (0-based).
	Map *FunctionsExpressionExpression `json:"map,omitempty"`
	// Expression to transform the fixed 0.5 output.
	// Receives: `input`, `output` as `Scalar(0.5)`.
	Output FunctionsExpressionExpression `json:"output"`
	// If this expression evaluates to true, skip the task. Receives: `input`.
	Skip *FunctionsExpressionExpression `json:"skip,omitempty"`
}

Expression for a placeholder scalar function task (pre-compilation).

Like [`ScalarFunctionTaskExpression`] but without owner/repository/commit. Always produces a fixed output of 0.5.

func (FunctionsPlaceholderScalarFunctionTaskExpression) SchemaTitle ¶ 

func (FunctionsPlaceholderScalarFunctionTaskExpression) SchemaTitle() string

func (*FunctionsPlaceholderScalarFunctionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsPlaceholderScalarFunctionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsPlaceholderScalarFunctionTaskExpression) Validate ¶ 

func (v FunctionsPlaceholderScalarFunctionTaskExpression) Validate() error

type FunctionsPlaceholderScalarFunctionTaskExpressionInput ¶ 

type FunctionsPlaceholderScalarFunctionTaskExpressionInput struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *FunctionsExpressionInputValueExpression
}

Expression for the input to pass to the placeholder function. Receives: `input`, `map` (if mapped).

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (FunctionsPlaceholderScalarFunctionTaskExpressionInput) MarshalJSON ¶ 

func (v FunctionsPlaceholderScalarFunctionTaskExpressionInput) MarshalJSON() ([]byte, error)

func (*FunctionsPlaceholderScalarFunctionTaskExpressionInput) UnmarshalJSON ¶ 

func (v *FunctionsPlaceholderScalarFunctionTaskExpressionInput) UnmarshalJSON(data []byte) error

func (FunctionsPlaceholderScalarFunctionTaskExpressionInput) Validate ¶ 

func (v FunctionsPlaceholderScalarFunctionTaskExpressionInput) Validate() error

type FunctionsPlaceholderVectorFunctionTask ¶ 

type FunctionsPlaceholderVectorFunctionTask struct {
	// The resolved input.
	Input FunctionsExpressionInputValue `json:"input"`
	// Expression merging sub-inputs back into one input.
	InputMerge FunctionsExpressionExpression `json:"input_merge"`
	// JSON Schema defining the expected input structure.
	InputSchema FunctionsExpressionInputSchema `json:"input_schema"`
	// Expression transforming input into sub-inputs for swiss system.
	InputSplit FunctionsExpressionExpression `json:"input_split"`
	// Expression to transform the equalized vector output.
	Output FunctionsExpressionExpression `json:"output"`
	// Expression computing the expected output vector length.
	OutputLength FunctionsExpressionExpression `json:"output_length"`
}

A compiled placeholder vector function task.

Always produces `Vector(vec![1/N; output_length])` before the output expression is applied.

func (FunctionsPlaceholderVectorFunctionTask) SchemaTitle ¶ 

func (FunctionsPlaceholderVectorFunctionTask) SchemaTitle() string

func (*FunctionsPlaceholderVectorFunctionTask) UnmarshalJSON ¶ 

func (v *FunctionsPlaceholderVectorFunctionTask) UnmarshalJSON(data []byte) error

func (FunctionsPlaceholderVectorFunctionTask) Validate ¶ 

func (v FunctionsPlaceholderVectorFunctionTask) Validate() error

type FunctionsPlaceholderVectorFunctionTaskExpression ¶ 

type FunctionsPlaceholderVectorFunctionTaskExpression struct {
	// Expression for the input to pass to the placeholder function.
	// Receives: `input`, `map` (if mapped).
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Input FunctionsPlaceholderVectorFunctionTaskExpressionInput `json:"input"`
	// Expression merging sub-inputs back into one input.
	// Receives: `input` (as an array).
	InputMerge FunctionsExpressionExpression `json:"input_merge"`
	// JSON Schema defining the expected input structure.
	InputSchema FunctionsExpressionInputSchema `json:"input_schema"`
	// Expression transforming input into sub-inputs for swiss system.
	// Receives: `input`.
	InputSplit FunctionsExpressionExpression `json:"input_split"`
	// Expression that evaluates to the number of mapped task instances.
	// Each instance receives `map` as an integer index (0-based).
	Map *FunctionsExpressionExpression `json:"map,omitempty"`
	// Expression to transform the equalized vector output.
	// Receives: `input`, `output` as `Vector(equalized)`.
	Output FunctionsExpressionExpression `json:"output"`
	// Expression computing the expected output vector length.
	// Receives: `input`.
	OutputLength FunctionsExpressionExpression `json:"output_length"`
	// If this expression evaluates to true, skip the task. Receives: `input`.
	Skip *FunctionsExpressionExpression `json:"skip,omitempty"`
}

Expression for a placeholder vector function task (pre-compilation).

Like [`VectorFunctionTaskExpression`] but without owner/repository/commit. Always produces an equalized vector of length `output_length`.

func (FunctionsPlaceholderVectorFunctionTaskExpression) SchemaTitle ¶ 

func (FunctionsPlaceholderVectorFunctionTaskExpression) SchemaTitle() string

func (*FunctionsPlaceholderVectorFunctionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsPlaceholderVectorFunctionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsPlaceholderVectorFunctionTaskExpression) Validate ¶ 

func (v FunctionsPlaceholderVectorFunctionTaskExpression) Validate() error

type FunctionsPlaceholderVectorFunctionTaskExpressionInput ¶ 

type FunctionsPlaceholderVectorFunctionTaskExpressionInput struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *FunctionsExpressionInputValueExpression
}

Expression for the input to pass to the placeholder function. Receives: `input`, `map` (if mapped).

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (FunctionsPlaceholderVectorFunctionTaskExpressionInput) MarshalJSON ¶ 

func (v FunctionsPlaceholderVectorFunctionTaskExpressionInput) MarshalJSON() ([]byte, error)

func (*FunctionsPlaceholderVectorFunctionTaskExpressionInput) UnmarshalJSON ¶ 

func (v *FunctionsPlaceholderVectorFunctionTaskExpressionInput) UnmarshalJSON(data []byte) error

func (FunctionsPlaceholderVectorFunctionTaskExpressionInput) Validate ¶ 

func (v FunctionsPlaceholderVectorFunctionTaskExpressionInput) Validate() error

type FunctionsProfile ¶ 

type FunctionsProfile struct {
	// A remote profile with metadata.
	Remote *FunctionsRemoteProfile
	// An inline profile definition.
	Inline *FunctionsInlineProfile
}

A Profile definition, either remote or inline.

Profiles contain the weights and nested configurations needed to execute a Function. They correspond to a Function's task structure.

func (FunctionsProfile) MarshalJSON ¶ 

func (v FunctionsProfile) MarshalJSON() ([]byte, error)

func (FunctionsProfile) SchemaTitle ¶ 

func (FunctionsProfile) SchemaTitle() string

func (*FunctionsProfile) UnmarshalJSON ¶ 

func (v *FunctionsProfile) UnmarshalJSON(data []byte) error

func (FunctionsProfile) Validate ¶ 

func (v FunctionsProfile) Validate() error

type FunctionsProfilesComputationsRequestDatasetItem ¶ 

type FunctionsProfilesComputationsRequestDatasetItem struct {
	Input  FunctionsExpressionInputValue              `json:"input"`
	Target FunctionsProfilesComputationsRequestTarget `json:"target"`
}

func (FunctionsProfilesComputationsRequestDatasetItem) SchemaTitle ¶ 

func (FunctionsProfilesComputationsRequestDatasetItem) SchemaTitle() string

func (*FunctionsProfilesComputationsRequestDatasetItem) UnmarshalJSON ¶ 

func (v *FunctionsProfilesComputationsRequestDatasetItem) UnmarshalJSON(data []byte) error

func (FunctionsProfilesComputationsRequestDatasetItem) Validate ¶ 

func (v FunctionsProfilesComputationsRequestDatasetItem) Validate() error

type FunctionsProfilesComputationsRequestFunctionProfileComputationCreateParams ¶ 

type FunctionsProfilesComputationsRequestFunctionProfileComputationCreateParams struct {
	Dataset   []FunctionsProfilesComputationsRequestDatasetItem `json:"dataset"`
	FromCache *bool                                             `json:"from_cache,omitempty"`
	// The function to compute a profile for (inline definition or remote path).
	Function   FunctionsFullInlineFunctionOrRemoteCommitOptional `json:"function"`
	MaxRetries *uint64                                           `json:"max_retries,omitempty" validate:"omitempty,min=0,max=18446744073709551615"`
	N          uint64                                            `json:"n" validate:"min=0,max=18446744073709551615"`
	Provider   *AgentCompletionsRequestProvider                  `json:"provider,omitempty"`
	RetryToken *string                                           `json:"retry_token,omitempty"`
	Seed       *int64                                            `json:"seed,omitempty" validate:"omitempty,min=-9223372036854775808,max=9223372036854775807"`
	Stream     *bool                                             `json:"stream,omitempty"`
	Swarm      SwarmInlineSwarmBaseOrRemoteCommitOptional        `json:"swarm"`
}

Parameters for creating a function profile computation.

func (FunctionsProfilesComputationsRequestFunctionProfileComputationCreateParams) SchemaTitle ¶ 

func (FunctionsProfilesComputationsRequestFunctionProfileComputationCreateParams) SchemaTitle() string

func (*FunctionsProfilesComputationsRequestFunctionProfileComputationCreateParams) UnmarshalJSON ¶ 

func (v *FunctionsProfilesComputationsRequestFunctionProfileComputationCreateParams) UnmarshalJSON(data []byte) error

func (FunctionsProfilesComputationsRequestFunctionProfileComputationCreateParams) Validate ¶ 

func (v FunctionsProfilesComputationsRequestFunctionProfileComputationCreateParams) Validate() error

type FunctionsProfilesComputationsRequestTarget ¶ 

type FunctionsProfilesComputationsRequestTarget struct {
	Scalar       *FunctionsProfilesComputationsRequestTargetScalar
	Vector       *FunctionsProfilesComputationsRequestTargetVector
	VectorWinner *FunctionsProfilesComputationsRequestTargetVectorWinner
}

func (FunctionsProfilesComputationsRequestTarget) MarshalJSON ¶ 

func (v FunctionsProfilesComputationsRequestTarget) MarshalJSON() ([]byte, error)

func (FunctionsProfilesComputationsRequestTarget) SchemaTitle ¶ 

func (FunctionsProfilesComputationsRequestTarget) SchemaTitle() string

func (*FunctionsProfilesComputationsRequestTarget) UnmarshalJSON ¶ 

func (v *FunctionsProfilesComputationsRequestTarget) UnmarshalJSON(data []byte) error

func (FunctionsProfilesComputationsRequestTarget) Validate ¶ 

func (v FunctionsProfilesComputationsRequestTarget) Validate() error

type FunctionsProfilesComputationsRequestTargetScalar ¶ 

type FunctionsProfilesComputationsRequestTargetScalar struct {
	Type  string  `json:"type" validate:"oneof=scalar"`
	Value float64 `json:"value" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

func (FunctionsProfilesComputationsRequestTargetScalar) SchemaVariantTitle ¶ 

func (FunctionsProfilesComputationsRequestTargetScalar) SchemaVariantTitle() string

func (*FunctionsProfilesComputationsRequestTargetScalar) UnmarshalJSON ¶ 

func (v *FunctionsProfilesComputationsRequestTargetScalar) UnmarshalJSON(data []byte) error

type FunctionsProfilesComputationsRequestTargetVector ¶ 

type FunctionsProfilesComputationsRequestTargetVector struct {
	Type  string    `json:"type" validate:"oneof=vector"`
	Value []float64 `json:"value" validate:"dive,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

func (FunctionsProfilesComputationsRequestTargetVector) SchemaVariantTitle ¶ 

func (FunctionsProfilesComputationsRequestTargetVector) SchemaVariantTitle() string

func (*FunctionsProfilesComputationsRequestTargetVector) UnmarshalJSON ¶ 

func (v *FunctionsProfilesComputationsRequestTargetVector) UnmarshalJSON(data []byte) error

type FunctionsProfilesComputationsRequestTargetVectorWinner ¶ 

type FunctionsProfilesComputationsRequestTargetVectorWinner struct {
	Type  string `json:"type" validate:"oneof=vector_winner"`
	Value uint32 `json:"value" validate:"min=0,max=4294967295"`
}

func (FunctionsProfilesComputationsRequestTargetVectorWinner) SchemaVariantTitle ¶ 

func (FunctionsProfilesComputationsRequestTargetVectorWinner) SchemaVariantTitle() string

func (*FunctionsProfilesComputationsRequestTargetVectorWinner) UnmarshalJSON ¶ 

func (v *FunctionsProfilesComputationsRequestTargetVectorWinner) UnmarshalJSON(data []byte) error

type FunctionsProfilesComputationsResponseFittingStats ¶ 

type FunctionsProfilesComputationsResponseFittingStats struct {
	Errors     uint32  `json:"errors" validate:"min=0,max=4294967295"`
	Executions uint32  `json:"executions" validate:"min=0,max=4294967295"`
	Loss       float64 `json:"loss" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	Rounds     uint32  `json:"rounds" validate:"min=0,max=4294967295"`
	Starts     uint32  `json:"starts" validate:"min=0,max=4294967295"`
}

func (FunctionsProfilesComputationsResponseFittingStats) SchemaTitle ¶ 

func (FunctionsProfilesComputationsResponseFittingStats) SchemaTitle() string

func (*FunctionsProfilesComputationsResponseFittingStats) UnmarshalJSON ¶ 

func (v *FunctionsProfilesComputationsResponseFittingStats) UnmarshalJSON(data []byte) error

func (FunctionsProfilesComputationsResponseFittingStats) Validate ¶ 

func (v FunctionsProfilesComputationsResponseFittingStats) Validate() error

type FunctionsProfilesComputationsResponseStreamingFunctionExecutionChunk ¶ 

type FunctionsProfilesComputationsResponseStreamingFunctionExecutionChunk struct {
	Created     uint64                                                     `json:"created" validate:"min=0,max=18446744073709551615"`
	Dataset     uint64                                                     `json:"dataset" validate:"min=0,max=18446744073709551615"`
	Error       *ErrorResponseError                                        `json:"error,omitempty"`
	Function    *RemotePath                                                `json:"function"`
	ID          string                                                     `json:"id"`
	Index       uint64                                                     `json:"index" validate:"min=0,max=18446744073709551615"`
	N           uint64                                                     `json:"n" validate:"min=0,max=18446744073709551615"`
	Object      FunctionsExecutionsResponseStreamingObject                 `json:"object"`
	Output      *FunctionsExecutionsResponseOutput                         `json:"output,omitempty"`
	Profile     *RemotePath                                                `json:"profile"`
	Reasoning   *FunctionsExecutionsResponseStreamingReasoningSummaryChunk `json:"reasoning,omitempty"`
	Retry       uint64                                                     `json:"retry" validate:"min=0,max=18446744073709551615"`
	RetryToken  *string                                                    `json:"retry_token,omitempty"`
	Tasks       []FunctionsExecutionsResponseStreamingTaskChunk            `json:"tasks"`
	TasksErrors *bool                                                      `json:"tasks_errors,omitempty"`
	Usage       *AgentCompletionsResponseUsage                             `json:"usage,omitempty"`
}

func (*FunctionsProfilesComputationsResponseStreamingFunctionExecutionChunk) Push ¶ 

func (v *FunctionsProfilesComputationsResponseStreamingFunctionExecutionChunk) Push(other *FunctionsProfilesComputationsResponseStreamingFunctionExecutionChunk)

Push accumulates another profile computations FunctionExecutionChunk into this one.

func (FunctionsProfilesComputationsResponseStreamingFunctionExecutionChunk) SchemaTitle ¶ 

func (FunctionsProfilesComputationsResponseStreamingFunctionExecutionChunk) SchemaTitle() string

func (*FunctionsProfilesComputationsResponseStreamingFunctionExecutionChunk) UnmarshalJSON ¶ 

func (v *FunctionsProfilesComputationsResponseStreamingFunctionExecutionChunk) UnmarshalJSON(data []byte) error

func (FunctionsProfilesComputationsResponseStreamingFunctionExecutionChunk) Validate ¶ 

func (v FunctionsProfilesComputationsResponseStreamingFunctionExecutionChunk) Validate() error

type FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk ¶ 

type FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk struct {
	Created          uint64                                                                 `json:"created" validate:"min=0,max=18446744073709551615"`
	Executions       []FunctionsProfilesComputationsResponseStreamingFunctionExecutionChunk `json:"executions"`
	ExecutionsErrors *bool                                                                  `json:"executions_errors,omitempty"`
	FittingStats     *FunctionsProfilesComputationsResponseFittingStats                     `json:"fitting_stats,omitempty"`
	Function         *RemotePath                                                            `json:"function"`
	ID               string                                                                 `json:"id"`
	Object           FunctionsProfilesComputationsResponseStreamingObject                   `json:"object"`
	Profile          *FunctionsInlineTasksProfile                                           `json:"profile,omitempty"`
	RetryToken       *string                                                                `json:"retry_token,omitempty"`
	Usage            *AgentCompletionsResponseUsage                                         `json:"usage,omitempty"`
}

func FunctionProfileComputationChunkMerged ¶ 

func FunctionProfileComputationChunkMerged(a, b FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk) (*FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk, error)

FunctionProfileComputationChunkMerged merges two FunctionProfileComputationChunks via push.

func FunctionProfileComputationChunkNormalized ¶ 

func FunctionProfileComputationChunkNormalized(chunk FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk) (*FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk, error)

FunctionProfileComputationChunkNormalized normalizes a FunctionProfileComputationChunk.

func GenerateFunctionProfileComputationChunk ¶ 

func GenerateFunctionProfileComputationChunk(hasSeed bool, seed int64) (*FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk, error)

GenerateFunctionProfileComputationChunk generates a random FunctionProfileComputationChunk from a seed.

func (*FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk) Push ¶ 

func (v *FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk) Push(other *FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk)

Push accumulates another FunctionProfileComputationChunk into this one.

func (FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk) SchemaTitle ¶ 

func (FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk) SchemaTitle() string

func (*FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk) UnmarshalJSON ¶ 

func (v *FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk) UnmarshalJSON(data []byte) error

func (FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk) Validate ¶ 

func (v FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk) Validate() error

type FunctionsProfilesComputationsResponseStreamingObject ¶ 

type FunctionsProfilesComputationsResponseStreamingObject struct {
	FunctionProfileComputationChunk string `validate:"omitempty,oneof=function.profile.computation.chunk"`
}

func (FunctionsProfilesComputationsResponseStreamingObject) MarshalJSON ¶ 

func (v FunctionsProfilesComputationsResponseStreamingObject) MarshalJSON() ([]byte, error)

func (FunctionsProfilesComputationsResponseStreamingObject) SchemaTitle ¶ 

func (FunctionsProfilesComputationsResponseStreamingObject) SchemaTitle() string

func (*FunctionsProfilesComputationsResponseStreamingObject) UnmarshalJSON ¶ 

func (v *FunctionsProfilesComputationsResponseStreamingObject) UnmarshalJSON(data []byte) error

func (FunctionsProfilesComputationsResponseStreamingObject) Validate ¶ 

func (v FunctionsProfilesComputationsResponseStreamingObject) Validate() error

type FunctionsProfilesComputationsResponseUnaryFunctionExecution ¶ 

type FunctionsProfilesComputationsResponseUnaryFunctionExecution struct {
	// Unix timestamp when the execution was created.
	Created uint64 `json:"created" validate:"min=0,max=18446744073709551615"`
	Dataset uint64 `json:"dataset" validate:"min=0,max=18446744073709551615"`
	// Error details if the execution failed.
	Error *ErrorResponseError `json:"error"`
	// The function used (if remote).
	Function *RemotePath `json:"function"`
	// Unique identifier for this execution.
	ID    string `json:"id"`
	Index uint64 `json:"index" validate:"min=0,max=18446744073709551615"`
	N     uint64 `json:"n" validate:"min=0,max=18446744073709551615"`
	// Object type identifier.
	Object FunctionsExecutionsResponseUnaryObject `json:"object"`
	// The final output (scalar or vector score).
	Output FunctionsExecutionsResponseOutput `json:"output"`
	// The profile used (if remote).
	Profile *RemotePath `json:"profile"`
	// Reasoning summary if reasoning was enabled.
	Reasoning *FunctionsExecutionsResponseUnaryReasoningSummary `json:"reasoning"`
	Retry     uint64                                            `json:"retry" validate:"min=0,max=18446744073709551615"`
	// Token for retrying this execution with cached votes.
	RetryToken *string `json:"retry_token"`
	// Results from each task in the function.
	Tasks []FunctionsExecutionsResponseUnaryTask `json:"tasks"`
	// Whether any tasks encountered errors.
	TasksErrors bool `json:"tasks_errors"`
	// Aggregated token and cost usage.
	Usage AgentCompletionsResponseUsage `json:"usage"`
}

A complete function execution response (non-streaming).

func (FunctionsProfilesComputationsResponseUnaryFunctionExecution) SchemaTitle ¶ 

func (FunctionsProfilesComputationsResponseUnaryFunctionExecution) SchemaTitle() string

func (*FunctionsProfilesComputationsResponseUnaryFunctionExecution) UnmarshalJSON ¶ 

func (v *FunctionsProfilesComputationsResponseUnaryFunctionExecution) UnmarshalJSON(data []byte) error

func (FunctionsProfilesComputationsResponseUnaryFunctionExecution) Validate ¶ 

func (v FunctionsProfilesComputationsResponseUnaryFunctionExecution) Validate() error

type FunctionsProfilesComputationsResponseUnaryFunctionProfileComputation ¶ 

type FunctionsProfilesComputationsResponseUnaryFunctionProfileComputation struct {
	Created          uint64                                                        `json:"created" validate:"min=0,max=18446744073709551615"`
	Executions       []FunctionsProfilesComputationsResponseUnaryFunctionExecution `json:"executions"`
	ExecutionsErrors bool                                                          `json:"executions_errors"`
	FittingStats     FunctionsProfilesComputationsResponseFittingStats             `json:"fitting_stats"`
	Function         *RemotePath                                                   `json:"function"`
	ID               string                                                        `json:"id"`
	Object           FunctionsProfilesComputationsResponseUnaryObject              `json:"object"`
	Profile          FunctionsInlineTasksProfile                                   `json:"profile"`
	RetryToken       *string                                                       `json:"retry_token"`
	Usage            AgentCompletionsResponseUsage                                 `json:"usage"`
}

func FunctionProfileComputationChunkToUnary ¶ 

func FunctionProfileComputationChunkToUnary(chunk FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk) (*FunctionsProfilesComputationsResponseUnaryFunctionProfileComputation, error)

FunctionProfileComputationChunkToUnary converts an accumulated chunk to a unary FunctionProfileComputation.

func FunctionsProfilesComputationsComputeProfileUnary ¶ 

func FunctionsProfilesComputationsComputeProfileUnary(ctx context.Context, c *Client, params FunctionsProfilesComputationsRequestFunctionProfileComputationCreateParams) (*FunctionsProfilesComputationsResponseUnaryFunctionProfileComputation, error)

func NormalizeFunctionProfileComputationForTests ¶ 

func NormalizeFunctionProfileComputationForTests(v FunctionsProfilesComputationsResponseUnaryFunctionProfileComputation) (*FunctionsProfilesComputationsResponseUnaryFunctionProfileComputation, error)

NormalizeFunctionProfileComputationForTests normalizes a FunctionProfileComputation by round-tripping through serde.

func (FunctionsProfilesComputationsResponseUnaryFunctionProfileComputation) SchemaTitle ¶ 

func (FunctionsProfilesComputationsResponseUnaryFunctionProfileComputation) SchemaTitle() string

func (*FunctionsProfilesComputationsResponseUnaryFunctionProfileComputation) UnmarshalJSON ¶ 

func (v *FunctionsProfilesComputationsResponseUnaryFunctionProfileComputation) UnmarshalJSON(data []byte) error

func (FunctionsProfilesComputationsResponseUnaryFunctionProfileComputation) Validate ¶ 

func (v FunctionsProfilesComputationsResponseUnaryFunctionProfileComputation) Validate() error

type FunctionsProfilesComputationsResponseUnaryObject ¶ 

type FunctionsProfilesComputationsResponseUnaryObject struct {
	FunctionProfileComputation string `validate:"omitempty,oneof=function.profile.computation"`
}

func (FunctionsProfilesComputationsResponseUnaryObject) MarshalJSON ¶ 

func (v FunctionsProfilesComputationsResponseUnaryObject) MarshalJSON() ([]byte, error)

func (FunctionsProfilesComputationsResponseUnaryObject) SchemaTitle ¶ 

func (FunctionsProfilesComputationsResponseUnaryObject) SchemaTitle() string

func (*FunctionsProfilesComputationsResponseUnaryObject) UnmarshalJSON ¶ 

func (v *FunctionsProfilesComputationsResponseUnaryObject) UnmarshalJSON(data []byte) error

func (FunctionsProfilesComputationsResponseUnaryObject) Validate ¶ 

func (v FunctionsProfilesComputationsResponseUnaryObject) Validate() error

type FunctionsProfilesComputationsRetryToken ¶ 

type FunctionsProfilesComputationsRetryToken []*string

func (FunctionsProfilesComputationsRetryToken) SchemaTitle ¶ 

func (FunctionsProfilesComputationsRetryToken) SchemaTitle() string

type FunctionsProfilesGetProfileResponse ¶ 

type FunctionsProfilesGetProfileResponse struct {
	RemotePath
}

func FunctionsProfilesGetProfile ¶ 

func FunctionsProfilesGetProfile(ctx context.Context, c *Client, params RemotePathCommitOptional) (*FunctionsProfilesGetProfileResponse, error)

func (FunctionsProfilesGetProfileResponse) SchemaTitle ¶ 

func (FunctionsProfilesGetProfileResponse) SchemaTitle() string

func (FunctionsProfilesGetProfileResponse) Validate ¶ 

func (v FunctionsProfilesGetProfileResponse) Validate() error

type FunctionsProfilesListProfileResponse ¶ 

type FunctionsProfilesListProfileResponse struct {
	// List of available profiles.
	Data []RemotePath `json:"data"`
}

Response from listing profiles.

func FunctionsProfilesListProfiles ¶ 

func FunctionsProfilesListProfiles(ctx context.Context, c *Client, params FunctionsProfilesListProfilesRequest) (*FunctionsProfilesListProfileResponse, error)

func (FunctionsProfilesListProfileResponse) SchemaTitle ¶ 

func (FunctionsProfilesListProfileResponse) SchemaTitle() string

func (*FunctionsProfilesListProfileResponse) UnmarshalJSON ¶ 

func (v *FunctionsProfilesListProfileResponse) UnmarshalJSON(data []byte) error

func (FunctionsProfilesListProfileResponse) Validate ¶ 

func (v FunctionsProfilesListProfileResponse) Validate() error

type FunctionsProfilesListProfilesRequest ¶ 

type FunctionsProfilesListProfilesRequest struct {
	// Optional source filter for listing profiles.
	Source *FunctionsProfilesListProfilesSource `json:"source,omitempty"`
}

Query parameters for the list profiles endpoint.

func (FunctionsProfilesListProfilesRequest) SchemaTitle ¶ 

func (FunctionsProfilesListProfilesRequest) SchemaTitle() string

func (FunctionsProfilesListProfilesRequest) Validate ¶ 

func (v FunctionsProfilesListProfilesRequest) Validate() error

type FunctionsProfilesListProfilesSource ¶ 

type FunctionsProfilesListProfilesSource struct {
	All         *string `validate:"omitempty,oneof=all"`
	Mock        *string `validate:"omitempty,oneof=mock"`
	Filesystem  *string `validate:"omitempty,oneof=filesystem"`
	Objectiveai *string `validate:"omitempty,oneof=objectiveai"`
}

Source filter for listing profiles.

func (FunctionsProfilesListProfilesSource) MarshalJSON ¶ 

func (v FunctionsProfilesListProfilesSource) MarshalJSON() ([]byte, error)

func (FunctionsProfilesListProfilesSource) SchemaTitle ¶ 

func (FunctionsProfilesListProfilesSource) SchemaTitle() string

func (*FunctionsProfilesListProfilesSource) UnmarshalJSON ¶ 

func (v *FunctionsProfilesListProfilesSource) UnmarshalJSON(data []byte) error

func (FunctionsProfilesListProfilesSource) Validate ¶ 

func (v FunctionsProfilesListProfilesSource) Validate() error

type FunctionsProfilesUsageProfileResponse ¶ 

type FunctionsProfilesUsageProfileResponse struct {
	// Total completion tokens used.
	CompletionTokens uint64 `json:"completion_tokens" validate:"min=0,max=18446744073709551615"`
	// Total prompt tokens used.
	PromptTokens uint64 `json:"prompt_tokens" validate:"min=0,max=18446744073709551615"`
	// Total number of requests made with this profile.
	Requests uint64 `json:"requests" validate:"min=0,max=18446744073709551615"`
	// Total cost incurred.
	TotalCost float64 `json:"total_cost" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

Usage statistics for a profile.

func FunctionsProfilesGetProfileUsage ¶ 

func FunctionsProfilesGetProfileUsage(ctx context.Context, c *Client, params RemotePathCommitOptional) (*FunctionsProfilesUsageProfileResponse, error)

func (FunctionsProfilesUsageProfileResponse) SchemaTitle ¶ 

func (FunctionsProfilesUsageProfileResponse) SchemaTitle() string

func (*FunctionsProfilesUsageProfileResponse) UnmarshalJSON ¶ 

func (v *FunctionsProfilesUsageProfileResponse) UnmarshalJSON(data []byte) error

func (FunctionsProfilesUsageProfileResponse) Validate ¶ 

func (v FunctionsProfilesUsageProfileResponse) Validate() error

type FunctionsRemoteFunction ¶ 

type FunctionsRemoteFunction struct {
	// Produces a single score in [0, 1].
	Scalar *FunctionsRemoteFunctionScalar
	// Produces a vector of scores that sums to 1.
	Vector *FunctionsRemoteFunctionVector
}

A remote function with full metadata.

Remote functions are stored as `function.json` in repositories and referenced by `remote/owner/repository`. They include documentation fields that inline functions lack.

func (FunctionsRemoteFunction) MarshalJSON ¶ 

func (v FunctionsRemoteFunction) MarshalJSON() ([]byte, error)

func (FunctionsRemoteFunction) SchemaTitle ¶ 

func (FunctionsRemoteFunction) SchemaTitle() string

func (*FunctionsRemoteFunction) UnmarshalJSON ¶ 

func (v *FunctionsRemoteFunction) UnmarshalJSON(data []byte) error

func (FunctionsRemoteFunction) Validate ¶ 

func (v FunctionsRemoteFunction) Validate() error

type FunctionsRemoteFunctionScalar ¶ 

type FunctionsRemoteFunctionScalar struct {
	// Human-readable description of what the function does.
	Description string `json:"description"`
	// JSON Schema defining the expected input structure.
	InputSchema FunctionsExpressionInputSchema `json:"input_schema"`
	// The list of tasks to execute. Tasks with a `map` expression are
	// expanded into multiple instances. Each instance is compiled with
	// `map` set to the current integer index.
	// Receives: `input`, `map` (if mapped).
	Tasks []FunctionsTaskExpression `json:"tasks"`
	Type  string                    `json:"type" validate:"oneof=scalar.function"`
}

Produces a single score in [0, 1].

func (FunctionsRemoteFunctionScalar) SchemaVariantTitle ¶ 

func (FunctionsRemoteFunctionScalar) SchemaVariantTitle() string

func (*FunctionsRemoteFunctionScalar) UnmarshalJSON ¶ 

func (v *FunctionsRemoteFunctionScalar) UnmarshalJSON(data []byte) error

type FunctionsRemoteFunctionVector ¶ 

type FunctionsRemoteFunctionVector struct {
	// Human-readable description of what the function does.
	Description string `json:"description"`
	// Expression transforming an array of inputs computed by `input_split`
	// into a single Input object for the Function.
	// Receives: `input` (as an array).
	InputMerge FunctionsExpressionExpression `json:"input_merge"`
	// JSON Schema defining the expected input structure.
	InputSchema FunctionsExpressionInputSchema `json:"input_schema"`
	// Expression transforming input into an input array of the output_length
	// When the Function is executed with any input from the array,
	// The output_length should be 1.
	// Receives: `input`.
	InputSplit FunctionsExpressionExpression `json:"input_split"`
	// Expression computing the expected output vector length for task outputs.
	// Receives: `input`.
	OutputLength FunctionsExpressionExpression `json:"output_length"`
	// The list of tasks to execute. Tasks with a `map` expression are
	// expanded into multiple instances. Each instance is compiled with
	// `map` set to the current integer index.
	// Receives: `input`, `map` (if mapped).
	Tasks []FunctionsTaskExpression `json:"tasks"`
	Type  string                    `json:"type" validate:"oneof=vector.function"`
}

Produces a vector of scores that sums to 1.

func (FunctionsRemoteFunctionVector) SchemaVariantTitle ¶ 

func (FunctionsRemoteFunctionVector) SchemaVariantTitle() string

func (*FunctionsRemoteFunctionVector) UnmarshalJSON ¶ 

func (v *FunctionsRemoteFunctionVector) UnmarshalJSON(data []byte) error

type FunctionsRemoteProfile ¶ 

type FunctionsRemoteProfile struct {
	// Tasks-based profile with per-task configuration.
	Tasks *FunctionsRemoteTasksProfile
	// Auto profile that applies a single swarm+weights to all vector completion tasks.
	Auto *SwarmRemoteSwarmBase
}

A remote profile, either tasks-based or auto.

func (FunctionsRemoteProfile) MarshalJSON ¶ 

func (v FunctionsRemoteProfile) MarshalJSON() ([]byte, error)

func (FunctionsRemoteProfile) SchemaTitle ¶ 

func (FunctionsRemoteProfile) SchemaTitle() string

func (*FunctionsRemoteProfile) UnmarshalJSON ¶ 

func (v *FunctionsRemoteProfile) UnmarshalJSON(data []byte) error

func (FunctionsRemoteProfile) Validate ¶ 

func (v FunctionsRemoteProfile) Validate() error

type FunctionsRemoteTasksProfile ¶ 

type FunctionsRemoteTasksProfile struct {
	FunctionsInlineTasksProfile
	// Human-readable description of the profile.
	Description string `json:"description"`
}

A remote tasks-based profile with full metadata.

Stored as `profile.json` in repositories and referenced by `remote/owner/repository`.

func (FunctionsRemoteTasksProfile) MarshalJSON ¶ 

func (v FunctionsRemoteTasksProfile) MarshalJSON() ([]byte, error)

func (FunctionsRemoteTasksProfile) SchemaTitle ¶ 

func (FunctionsRemoteTasksProfile) SchemaTitle() string

func (*FunctionsRemoteTasksProfile) UnmarshalJSON ¶ 

func (v *FunctionsRemoteTasksProfile) UnmarshalJSON(data []byte) error

func (FunctionsRemoteTasksProfile) Validate ¶ 

func (v FunctionsRemoteTasksProfile) Validate() error

type FunctionsScalarFunctionTask ¶ 

type FunctionsScalarFunctionTask struct {
	RemotePath
	// The resolved input to pass to the function.
	Input FunctionsExpressionInputValue `json:"input"`
	// Expression to transform the task result into a valid function output.
	//
	// Receives `output` as the nested function's result (Scalar or Vector).
	// Must return a `TaskOutputOwned` valid for the parent function's type (scalar or vector).
	// See [`ScalarFunctionTaskExpression::output`] for full documentation.
	Output FunctionsExpressionExpression `json:"output"`
}

A compiled scalar function task ready for execution.

func (FunctionsScalarFunctionTask) MarshalJSON ¶ 

func (v FunctionsScalarFunctionTask) MarshalJSON() ([]byte, error)

func (FunctionsScalarFunctionTask) SchemaTitle ¶ 

func (FunctionsScalarFunctionTask) SchemaTitle() string

func (*FunctionsScalarFunctionTask) UnmarshalJSON ¶ 

func (v *FunctionsScalarFunctionTask) UnmarshalJSON(data []byte) error

func (FunctionsScalarFunctionTask) Validate ¶ 

func (v FunctionsScalarFunctionTask) Validate() error

type FunctionsScalarFunctionTaskExpression ¶ 

type FunctionsScalarFunctionTaskExpression struct {
	RemotePath
	// Expression for the input to pass to the function.
	// Receives: `input`, `map` (if mapped).
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Input FunctionsScalarFunctionTaskExpressionInput `json:"input"`
	// Expression that evaluates to the number of mapped task instances.
	// Each instance receives `map` as an integer index (0-based).
	Map *FunctionsExpressionExpression `json:"map,omitempty"`
	// Expression to transform the task result into a valid function output.
	//
	// Receives `output` which is one of 4 variants:
	// - `Scalar(Decimal)` - a single score
	// - `Vector(Vec<Decimal>)` - a vector of scores
	// - `Vectors(Vec<Vec<Decimal>>)` - multiple vectors (from mapped tasks)
	// - `Err(Value)` - an error
	//
	// The expression must return a `TaskOutputOwned` that is valid for the parent function's type:
	// - For scalar functions: must return `Scalar(value)` where value is in [0, 1]
	// - For vector functions: must return `Vector(values)` where values sum to ~1 and match the expected length
	//
	// The function's final output is computed as a weighted average of all task outputs using
	// profile weights. If a function has only one task, that task's output becomes the function's
	// output directly.
	Output FunctionsExpressionExpression `json:"output"`
	// If this expression evaluates to true, skip the task. Receives: `input`.
	Skip *FunctionsExpressionExpression `json:"skip,omitempty"`
}

Expression for a task that calls a scalar function (pre-compilation).

func (FunctionsScalarFunctionTaskExpression) MarshalJSON ¶ 

func (v FunctionsScalarFunctionTaskExpression) MarshalJSON() ([]byte, error)

func (FunctionsScalarFunctionTaskExpression) SchemaTitle ¶ 

func (FunctionsScalarFunctionTaskExpression) SchemaTitle() string

func (*FunctionsScalarFunctionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsScalarFunctionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsScalarFunctionTaskExpression) Validate ¶ 

func (v FunctionsScalarFunctionTaskExpression) Validate() error

type FunctionsScalarFunctionTaskExpressionInput ¶ 

type FunctionsScalarFunctionTaskExpressionInput struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *FunctionsExpressionInputValueExpression
}

Expression for the input to pass to the function. Receives: `input`, `map` (if mapped).

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (FunctionsScalarFunctionTaskExpressionInput) MarshalJSON ¶ 

func (v FunctionsScalarFunctionTaskExpressionInput) MarshalJSON() ([]byte, error)

func (*FunctionsScalarFunctionTaskExpressionInput) UnmarshalJSON ¶ 

func (v *FunctionsScalarFunctionTaskExpressionInput) UnmarshalJSON(data []byte) error

func (FunctionsScalarFunctionTaskExpressionInput) Validate ¶ 

func (v FunctionsScalarFunctionTaskExpressionInput) Validate() error

type FunctionsTask ¶ 

type FunctionsTask struct {
	// Calls a scalar function (produces a single score).
	ScalarFunction *FunctionsTaskScalarFunction
	// Calls a vector function (produces a vector of scores).
	VectorFunction *FunctionsTaskVectorFunction
	// Runs a vector completion.
	VectorCompletion *FunctionsTaskVectorCompletion
	// Placeholder scalar function (always outputs 0.5).
	PlaceholderScalarFunction *FunctionsTaskPlaceholderScalarFunction
	// Placeholder vector function (always outputs equalized vector).
	PlaceholderVectorFunction *FunctionsTaskPlaceholderVectorFunction
}

A compiled task ready for execution.

Produced by compiling a [`TaskExpression`] against input data. All expressions have been resolved to concrete values.

func (FunctionsTask) MarshalJSON ¶ 

func (v FunctionsTask) MarshalJSON() ([]byte, error)

func (FunctionsTask) SchemaTitle ¶ 

func (FunctionsTask) SchemaTitle() string

func (*FunctionsTask) UnmarshalJSON ¶ 

func (v *FunctionsTask) UnmarshalJSON(data []byte) error

func (FunctionsTask) Validate ¶ 

func (v FunctionsTask) Validate() error

type FunctionsTaskExpression ¶ 

type FunctionsTaskExpression struct {
	ScalarFunction            *FunctionsTaskExpressionScalarFunction
	VectorFunction            *FunctionsTaskExpressionVectorFunction
	VectorCompletion          *FunctionsTaskExpressionVectorCompletion
	PlaceholderScalarFunction *FunctionsTaskExpressionPlaceholderScalarFunction
	PlaceholderVectorFunction *FunctionsTaskExpressionPlaceholderVectorFunction
}

A task definition with expressions (pre-compilation).

Task expressions contain dynamic fields (JMESPath or Starlark) that are resolved against input data during compilation. Use [`compile`](Self::compile) to produce a concrete [`Task`].

func (FunctionsTaskExpression) MarshalJSON ¶ 

func (v FunctionsTaskExpression) MarshalJSON() ([]byte, error)

func (FunctionsTaskExpression) SchemaTitle ¶ 

func (FunctionsTaskExpression) SchemaTitle() string

func (*FunctionsTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsTaskExpression) Validate ¶ 

func (v FunctionsTaskExpression) Validate() error

type FunctionsTaskExpressionPlaceholderScalarFunction ¶ 

type FunctionsTaskExpressionPlaceholderScalarFunction struct {
	FunctionsPlaceholderScalarFunctionTaskExpression
	Type string `json:"type" validate:"oneof=placeholder.scalar.function"`
}

func (FunctionsTaskExpressionPlaceholderScalarFunction) MarshalJSON ¶ 

func (v FunctionsTaskExpressionPlaceholderScalarFunction) MarshalJSON() ([]byte, error)

func (FunctionsTaskExpressionPlaceholderScalarFunction) SchemaVariantTitle ¶ 

func (FunctionsTaskExpressionPlaceholderScalarFunction) SchemaVariantTitle() string

func (*FunctionsTaskExpressionPlaceholderScalarFunction) UnmarshalJSON ¶ 

func (v *FunctionsTaskExpressionPlaceholderScalarFunction) UnmarshalJSON(data []byte) error

type FunctionsTaskExpressionPlaceholderVectorFunction ¶ 

type FunctionsTaskExpressionPlaceholderVectorFunction struct {
	FunctionsPlaceholderVectorFunctionTaskExpression
	Type string `json:"type" validate:"oneof=placeholder.vector.function"`
}

func (FunctionsTaskExpressionPlaceholderVectorFunction) MarshalJSON ¶ 

func (v FunctionsTaskExpressionPlaceholderVectorFunction) MarshalJSON() ([]byte, error)

func (FunctionsTaskExpressionPlaceholderVectorFunction) SchemaVariantTitle ¶ 

func (FunctionsTaskExpressionPlaceholderVectorFunction) SchemaVariantTitle() string

func (*FunctionsTaskExpressionPlaceholderVectorFunction) UnmarshalJSON ¶ 

func (v *FunctionsTaskExpressionPlaceholderVectorFunction) UnmarshalJSON(data []byte) error

type FunctionsTaskExpressionScalarFunction ¶ 

type FunctionsTaskExpressionScalarFunction struct {
	FunctionsScalarFunctionTaskExpression
	Type string `json:"type" validate:"oneof=scalar.function"`
}

func (FunctionsTaskExpressionScalarFunction) MarshalJSON ¶ 

func (v FunctionsTaskExpressionScalarFunction) MarshalJSON() ([]byte, error)

func (FunctionsTaskExpressionScalarFunction) SchemaVariantTitle ¶ 

func (FunctionsTaskExpressionScalarFunction) SchemaVariantTitle() string

func (*FunctionsTaskExpressionScalarFunction) UnmarshalJSON ¶ 

func (v *FunctionsTaskExpressionScalarFunction) UnmarshalJSON(data []byte) error

type FunctionsTaskExpressionVectorCompletion ¶ 

type FunctionsTaskExpressionVectorCompletion struct {
	FunctionsVectorCompletionTaskExpression
	Type string `json:"type" validate:"oneof=vector.completion"`
}

func (FunctionsTaskExpressionVectorCompletion) MarshalJSON ¶ 

func (v FunctionsTaskExpressionVectorCompletion) MarshalJSON() ([]byte, error)

func (FunctionsTaskExpressionVectorCompletion) SchemaVariantTitle ¶ 

func (FunctionsTaskExpressionVectorCompletion) SchemaVariantTitle() string

func (*FunctionsTaskExpressionVectorCompletion) UnmarshalJSON ¶ 

func (v *FunctionsTaskExpressionVectorCompletion) UnmarshalJSON(data []byte) error

type FunctionsTaskExpressionVectorFunction ¶ 

type FunctionsTaskExpressionVectorFunction struct {
	FunctionsVectorFunctionTaskExpression
	Type string `json:"type" validate:"oneof=vector.function"`
}

func (FunctionsTaskExpressionVectorFunction) MarshalJSON ¶ 

func (v FunctionsTaskExpressionVectorFunction) MarshalJSON() ([]byte, error)

func (FunctionsTaskExpressionVectorFunction) SchemaVariantTitle ¶ 

func (FunctionsTaskExpressionVectorFunction) SchemaVariantTitle() string

func (*FunctionsTaskExpressionVectorFunction) UnmarshalJSON ¶ 

func (v *FunctionsTaskExpressionVectorFunction) UnmarshalJSON(data []byte) error

type FunctionsTaskPlaceholderScalarFunction ¶ 

type FunctionsTaskPlaceholderScalarFunction struct {
	FunctionsPlaceholderScalarFunctionTask
	Type string `json:"type" validate:"oneof=placeholder.scalar.function"`
}

Placeholder scalar function (always outputs 0.5).

func (FunctionsTaskPlaceholderScalarFunction) MarshalJSON ¶ 

func (v FunctionsTaskPlaceholderScalarFunction) MarshalJSON() ([]byte, error)

func (FunctionsTaskPlaceholderScalarFunction) SchemaVariantTitle ¶ 

func (FunctionsTaskPlaceholderScalarFunction) SchemaVariantTitle() string

func (*FunctionsTaskPlaceholderScalarFunction) UnmarshalJSON ¶ 

func (v *FunctionsTaskPlaceholderScalarFunction) UnmarshalJSON(data []byte) error

type FunctionsTaskPlaceholderVectorFunction ¶ 

type FunctionsTaskPlaceholderVectorFunction struct {
	FunctionsPlaceholderVectorFunctionTask
	Type string `json:"type" validate:"oneof=placeholder.vector.function"`
}

Placeholder vector function (always outputs equalized vector).

func (FunctionsTaskPlaceholderVectorFunction) MarshalJSON ¶ 

func (v FunctionsTaskPlaceholderVectorFunction) MarshalJSON() ([]byte, error)

func (FunctionsTaskPlaceholderVectorFunction) SchemaVariantTitle ¶ 

func (FunctionsTaskPlaceholderVectorFunction) SchemaVariantTitle() string

func (*FunctionsTaskPlaceholderVectorFunction) UnmarshalJSON ¶ 

func (v *FunctionsTaskPlaceholderVectorFunction) UnmarshalJSON(data []byte) error

type FunctionsTaskProfile ¶ 

type FunctionsTaskProfile struct {
	// Profile for a nested function task (references another profile).
	Remote *RemotePath
	// Inline profile for a task (tasks-based or auto).
	Inline *FunctionsInlineProfile
	// Placeholder task — no configuration needed, output is fixed.
	Placeholder *FunctionsTaskProfilePlaceholder
}

Configuration for a single task within a Profile.

Each variant corresponds to a task type in the Function definition.

func (FunctionsTaskProfile) MarshalJSON ¶ 

func (v FunctionsTaskProfile) MarshalJSON() ([]byte, error)

func (FunctionsTaskProfile) SchemaTitle ¶ 

func (FunctionsTaskProfile) SchemaTitle() string

func (*FunctionsTaskProfile) UnmarshalJSON ¶ 

func (v *FunctionsTaskProfile) UnmarshalJSON(data []byte) error

func (FunctionsTaskProfile) Validate ¶ 

func (v FunctionsTaskProfile) Validate() error

type FunctionsTaskProfilePlaceholder ¶ 

type FunctionsTaskProfilePlaceholder struct{}

func (FunctionsTaskProfilePlaceholder) SchemaVariantTitle ¶ 

func (FunctionsTaskProfilePlaceholder) SchemaVariantTitle() string

type FunctionsTaskScalarFunction ¶ 

type FunctionsTaskScalarFunction struct {
	FunctionsScalarFunctionTask
	Type string `json:"type" validate:"oneof=scalar.function"`
}

Calls a scalar function (produces a single score).

func (FunctionsTaskScalarFunction) MarshalJSON ¶ 

func (v FunctionsTaskScalarFunction) MarshalJSON() ([]byte, error)

func (FunctionsTaskScalarFunction) SchemaVariantTitle ¶ 

func (FunctionsTaskScalarFunction) SchemaVariantTitle() string

func (*FunctionsTaskScalarFunction) UnmarshalJSON ¶ 

func (v *FunctionsTaskScalarFunction) UnmarshalJSON(data []byte) error

type FunctionsTaskVectorCompletion ¶ 

type FunctionsTaskVectorCompletion struct {
	FunctionsVectorCompletionTask
	Type string `json:"type" validate:"oneof=vector.completion"`
}

Runs a vector completion.

func (FunctionsTaskVectorCompletion) MarshalJSON ¶ 

func (v FunctionsTaskVectorCompletion) MarshalJSON() ([]byte, error)

func (FunctionsTaskVectorCompletion) SchemaVariantTitle ¶ 

func (FunctionsTaskVectorCompletion) SchemaVariantTitle() string

func (*FunctionsTaskVectorCompletion) UnmarshalJSON ¶ 

func (v *FunctionsTaskVectorCompletion) UnmarshalJSON(data []byte) error

type FunctionsTaskVectorFunction ¶ 

type FunctionsTaskVectorFunction struct {
	FunctionsVectorFunctionTask
	Type string `json:"type" validate:"oneof=vector.function"`
}

Calls a vector function (produces a vector of scores).

func (FunctionsTaskVectorFunction) MarshalJSON ¶ 

func (v FunctionsTaskVectorFunction) MarshalJSON() ([]byte, error)

func (FunctionsTaskVectorFunction) SchemaVariantTitle ¶ 

func (FunctionsTaskVectorFunction) SchemaVariantTitle() string

func (*FunctionsTaskVectorFunction) UnmarshalJSON ¶ 

func (v *FunctionsTaskVectorFunction) UnmarshalJSON(data []byte) error

type FunctionsUsageFunctionProfilePairResponse ¶ 

type FunctionsUsageFunctionProfilePairResponse struct {
	// Total completion tokens used.
	CompletionTokens uint64 `json:"completion_tokens" validate:"min=0,max=18446744073709551615"`
	// Total prompt tokens used.
	PromptTokens uint64 `json:"prompt_tokens" validate:"min=0,max=18446744073709551615"`
	// Total number of requests made with this function-profile pair.
	Requests uint64 `json:"requests" validate:"min=0,max=18446744073709551615"`
	// Total cost incurred.
	TotalCost float64 `json:"total_cost" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

Usage statistics for a function-profile pair.

func FunctionsGetFunctionProfilePairUsage ¶ 

func FunctionsGetFunctionProfilePairUsage(ctx context.Context, c *Client, params FunctionsGetFunctionProfilePairUsageRequest) (*FunctionsUsageFunctionProfilePairResponse, error)

func (FunctionsUsageFunctionProfilePairResponse) SchemaTitle ¶ 

func (FunctionsUsageFunctionProfilePairResponse) SchemaTitle() string

func (*FunctionsUsageFunctionProfilePairResponse) UnmarshalJSON ¶ 

func (v *FunctionsUsageFunctionProfilePairResponse) UnmarshalJSON(data []byte) error

func (FunctionsUsageFunctionProfilePairResponse) Validate ¶ 

func (v FunctionsUsageFunctionProfilePairResponse) Validate() error

type FunctionsUsageFunctionResponse ¶ 

type FunctionsUsageFunctionResponse struct {
	// Total completion tokens used.
	CompletionTokens uint64 `json:"completion_tokens" validate:"min=0,max=18446744073709551615"`
	// Total prompt tokens used.
	PromptTokens uint64 `json:"prompt_tokens" validate:"min=0,max=18446744073709551615"`
	// Total number of requests made with this function.
	Requests uint64 `json:"requests" validate:"min=0,max=18446744073709551615"`
	// Total cost incurred.
	TotalCost float64 `json:"total_cost" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

Usage statistics for a function.

func FunctionsGetFunctionUsage ¶ 

func FunctionsGetFunctionUsage(ctx context.Context, c *Client, params RemotePathCommitOptional) (*FunctionsUsageFunctionResponse, error)

func (FunctionsUsageFunctionResponse) SchemaTitle ¶ 

func (FunctionsUsageFunctionResponse) SchemaTitle() string

func (*FunctionsUsageFunctionResponse) UnmarshalJSON ¶ 

func (v *FunctionsUsageFunctionResponse) UnmarshalJSON(data []byte) error

func (FunctionsUsageFunctionResponse) Validate ¶ 

func (v FunctionsUsageFunctionResponse) Validate() error

type FunctionsVectorCompletionTask ¶ 

type FunctionsVectorCompletionTask struct {
	// The resolved conversation messages.
	Messages []AgentCompletionsMessageMessage `json:"messages"`
	// Expression to transform the task result into a valid function output.
	//
	// Receives `output` as the task's raw result (typically `Vector(scores)`).
	// Must return a `TaskOutputOwned` valid for the parent function's type (scalar or vector).
	// See [`VectorCompletionTaskExpression::output`] for full documentation.
	Output FunctionsExpressionExpression `json:"output"`
	// The resolved response options the LLMs can vote for.
	Responses []AgentCompletionsMessageRichContent `json:"responses"`
}

A compiled vector completion task ready for execution.

func (FunctionsVectorCompletionTask) SchemaTitle ¶ 

func (FunctionsVectorCompletionTask) SchemaTitle() string

func (*FunctionsVectorCompletionTask) UnmarshalJSON ¶ 

func (v *FunctionsVectorCompletionTask) UnmarshalJSON(data []byte) error

func (FunctionsVectorCompletionTask) Validate ¶ 

func (v FunctionsVectorCompletionTask) Validate() error

type FunctionsVectorCompletionTaskExpression ¶ 

type FunctionsVectorCompletionTaskExpression struct {
	// Expression that evaluates to the number of mapped task instances.
	// Each instance receives `map` as an integer index (0-based).
	Map *FunctionsExpressionExpression `json:"map,omitempty"`
	// Expression for the conversation messages (the prompt).
	// Receives: `input`, `map` (if mapped).
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Messages FunctionsVectorCompletionTaskExpressionMessages `json:"messages"`
	// Expression to transform the task result into a valid function output.
	//
	// Receives `output` as the task's raw result (typically `Vector(scores)`).
	//
	// The expression must return a `TaskOutputOwned` that is valid for the parent function's type:
	// - For scalar functions: must return `Scalar(value)` where value is in [0, 1]
	// - For vector functions: must return `Vector(values)` where values sum to ~1 and match the expected length
	//
	// The function's final output is computed as a weighted average of all task outputs using
	// profile weights. If a function has only one task, that task's output becomes the function's
	// output directly.
	Output FunctionsExpressionExpression `json:"output"`
	// Expression for the possible responses the LLMs can vote for.
	// Receives: `input`, `map` (if mapped).
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Responses FunctionsVectorCompletionTaskExpressionResponses `json:"responses"`
	// If this expression evaluates to true, skip the task. Receives: `input`.
	Skip *FunctionsExpressionExpression `json:"skip,omitempty"`
}

Expression for a task that runs a vector completion (pre-compilation).

func (FunctionsVectorCompletionTaskExpression) SchemaTitle ¶ 

func (FunctionsVectorCompletionTaskExpression) SchemaTitle() string

func (*FunctionsVectorCompletionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsVectorCompletionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsVectorCompletionTaskExpression) Validate ¶ 

func (v FunctionsVectorCompletionTaskExpression) Validate() error

type FunctionsVectorCompletionTaskExpressionMessages ¶ 

type FunctionsVectorCompletionTaskExpressionMessages struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *FunctionsVectorCompletionTaskExpressionMessagesValue
}

Expression for the conversation messages (the prompt). Receives: `input`, `map` (if mapped).

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (FunctionsVectorCompletionTaskExpressionMessages) MarshalJSON ¶ 

func (v FunctionsVectorCompletionTaskExpressionMessages) MarshalJSON() ([]byte, error)

func (*FunctionsVectorCompletionTaskExpressionMessages) UnmarshalJSON ¶ 

func (v *FunctionsVectorCompletionTaskExpressionMessages) UnmarshalJSON(data []byte) error

func (FunctionsVectorCompletionTaskExpressionMessages) Validate ¶ 

func (v FunctionsVectorCompletionTaskExpressionMessages) Validate() error

type FunctionsVectorCompletionTaskExpressionMessagesValue ¶ 

type FunctionsVectorCompletionTaskExpressionMessagesValue []FunctionsVectorCompletionTaskExpressionMessagesValueItem

func (FunctionsVectorCompletionTaskExpressionMessagesValue) SchemaVariantTitle ¶ 

func (FunctionsVectorCompletionTaskExpressionMessagesValue) SchemaVariantTitle() string

type FunctionsVectorCompletionTaskExpressionMessagesValueItem ¶ 

type FunctionsVectorCompletionTaskExpressionMessagesValueItem struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageMessageExpression
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (FunctionsVectorCompletionTaskExpressionMessagesValueItem) MarshalJSON ¶ 

func (v FunctionsVectorCompletionTaskExpressionMessagesValueItem) MarshalJSON() ([]byte, error)

func (*FunctionsVectorCompletionTaskExpressionMessagesValueItem) UnmarshalJSON ¶ 

func (v *FunctionsVectorCompletionTaskExpressionMessagesValueItem) UnmarshalJSON(data []byte) error

func (FunctionsVectorCompletionTaskExpressionMessagesValueItem) Validate ¶ 

func (v FunctionsVectorCompletionTaskExpressionMessagesValueItem) Validate() error

type FunctionsVectorCompletionTaskExpressionResponses ¶ 

type FunctionsVectorCompletionTaskExpressionResponses struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *FunctionsVectorCompletionTaskExpressionResponsesValue
}

Expression for the possible responses the LLMs can vote for. Receives: `input`, `map` (if mapped).

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (FunctionsVectorCompletionTaskExpressionResponses) MarshalJSON ¶ 

func (v FunctionsVectorCompletionTaskExpressionResponses) MarshalJSON() ([]byte, error)

func (*FunctionsVectorCompletionTaskExpressionResponses) UnmarshalJSON ¶ 

func (v *FunctionsVectorCompletionTaskExpressionResponses) UnmarshalJSON(data []byte) error

func (FunctionsVectorCompletionTaskExpressionResponses) Validate ¶ 

func (v FunctionsVectorCompletionTaskExpressionResponses) Validate() error

type FunctionsVectorCompletionTaskExpressionResponsesValue ¶ 

type FunctionsVectorCompletionTaskExpressionResponsesValue []FunctionsVectorCompletionTaskExpressionResponsesValueItem

func (FunctionsVectorCompletionTaskExpressionResponsesValue) SchemaVariantTitle ¶ 

func (FunctionsVectorCompletionTaskExpressionResponsesValue) SchemaVariantTitle() string

type FunctionsVectorCompletionTaskExpressionResponsesValueItem ¶ 

type FunctionsVectorCompletionTaskExpressionResponsesValueItem struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *AgentCompletionsMessageRichContentExpression
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (FunctionsVectorCompletionTaskExpressionResponsesValueItem) MarshalJSON ¶ 

func (v FunctionsVectorCompletionTaskExpressionResponsesValueItem) MarshalJSON() ([]byte, error)

func (*FunctionsVectorCompletionTaskExpressionResponsesValueItem) UnmarshalJSON ¶ 

func (v *FunctionsVectorCompletionTaskExpressionResponsesValueItem) UnmarshalJSON(data []byte) error

func (FunctionsVectorCompletionTaskExpressionResponsesValueItem) Validate ¶ 

func (v FunctionsVectorCompletionTaskExpressionResponsesValueItem) Validate() error

type FunctionsVectorFunctionTask ¶ 

type FunctionsVectorFunctionTask struct {
	RemotePath
	// The resolved input to pass to the function.
	Input FunctionsExpressionInputValue `json:"input"`
	// Expression to transform the task result into a valid function output.
	//
	// Receives `output` as the nested function's result (Scalar or Vector).
	// Must return a `TaskOutputOwned` valid for the parent function's type (scalar or vector).
	// See [`VectorFunctionTaskExpression::output`] for full documentation.
	Output FunctionsExpressionExpression `json:"output"`
}

A compiled vector function task ready for execution.

func (FunctionsVectorFunctionTask) MarshalJSON ¶ 

func (v FunctionsVectorFunctionTask) MarshalJSON() ([]byte, error)

func (FunctionsVectorFunctionTask) SchemaTitle ¶ 

func (FunctionsVectorFunctionTask) SchemaTitle() string

func (*FunctionsVectorFunctionTask) UnmarshalJSON ¶ 

func (v *FunctionsVectorFunctionTask) UnmarshalJSON(data []byte) error

func (FunctionsVectorFunctionTask) Validate ¶ 

func (v FunctionsVectorFunctionTask) Validate() error

type FunctionsVectorFunctionTaskExpression ¶ 

type FunctionsVectorFunctionTaskExpression struct {
	RemotePath
	// Expression for the input to pass to the function.
	// Receives: `input`, `map` (if mapped).
	//
	// A value that can be either a literal or an expression.
	//
	// This allows Function definitions to mix static values with dynamic
	// expressions. During compilation, expressions are evaluated while
	// literal values pass through unchanged.
	//
	// # Example
	//
	// Literal value:
	// “`json
	// "hello world"
	// “`
	//
	// JMESPath expression:
	// “`json
	// {"$jmespath": "input.greeting"}
	// “`
	//
	// Starlark expression:
	// “`json
	// {"$starlark": "input['greeting']"}
	// “`
	Input FunctionsVectorFunctionTaskExpressionInput `json:"input"`
	// Expression that evaluates to the number of mapped task instances.
	// Each instance receives `map` as an integer index (0-based).
	Map *FunctionsExpressionExpression `json:"map,omitempty"`
	// Expression to transform the task result into a valid function output.
	//
	// Receives `output` which is one of 4 variants:
	// - `Scalar(Decimal)` - a single score
	// - `Vector(Vec<Decimal>)` - a vector of scores
	// - `Vectors(Vec<Vec<Decimal>>)` - multiple vectors (from mapped tasks)
	// - `Err(Value)` - an error
	//
	// The expression must return a `TaskOutputOwned` that is valid for the parent function's type:
	// - For scalar functions: must return `Scalar(value)` where value is in [0, 1]
	// - For vector functions: must return `Vector(values)` where values sum to ~1 and match the expected length
	//
	// The function's final output is computed as a weighted average of all task outputs using
	// profile weights. If a function has only one task, that task's output becomes the function's
	// output directly.
	Output FunctionsExpressionExpression `json:"output"`
	// If this expression evaluates to true, skip the task. Receives: `input`.
	Skip *FunctionsExpressionExpression `json:"skip,omitempty"`
}

Expression for a task that calls a vector function (pre-compilation).

func (FunctionsVectorFunctionTaskExpression) MarshalJSON ¶ 

func (v FunctionsVectorFunctionTaskExpression) MarshalJSON() ([]byte, error)

func (FunctionsVectorFunctionTaskExpression) SchemaTitle ¶ 

func (FunctionsVectorFunctionTaskExpression) SchemaTitle() string

func (*FunctionsVectorFunctionTaskExpression) UnmarshalJSON ¶ 

func (v *FunctionsVectorFunctionTaskExpression) UnmarshalJSON(data []byte) error

func (FunctionsVectorFunctionTaskExpression) Validate ¶ 

func (v FunctionsVectorFunctionTaskExpression) Validate() error

type FunctionsVectorFunctionTaskExpressionInput ¶ 

type FunctionsVectorFunctionTaskExpressionInput struct {
	// An expression (JMESPath or Starlark) to evaluate.
	Expression *FunctionsExpressionExpression
	// A literal value.
	Value *FunctionsExpressionInputValueExpression
}

Expression for the input to pass to the function. Receives: `input`, `map` (if mapped).

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example ¶

Literal value: ```json "hello world" ```

JMESPath expression: ```json {"$jmespath": "input.greeting"} ```

Starlark expression: ```json {"$starlark": "input['greeting']"} ```

func (FunctionsVectorFunctionTaskExpressionInput) MarshalJSON ¶ 

func (v FunctionsVectorFunctionTaskExpressionInput) MarshalJSON() ([]byte, error)

func (*FunctionsVectorFunctionTaskExpressionInput) UnmarshalJSON ¶ 

func (v *FunctionsVectorFunctionTaskExpressionInput) UnmarshalJSON(data []byte) error

func (FunctionsVectorFunctionTaskExpressionInput) Validate ¶ 

func (v FunctionsVectorFunctionTaskExpressionInput) Validate() error

type JsonValue ¶ 

type JsonValue struct {
	Value any `json:"value"`
}

JsonValue wraps any JSON value. It serializes and deserializes transparently as the underlying value (object, array, string, number, boolean, or null). Unlike bare `any`, JsonValue is a concrete type that can have methods.

func (JsonValue) MarshalJSON ¶ 

func (v JsonValue) MarshalJSON() ([]byte, error)

func (*JsonValue) UnmarshalJSON ¶ 

func (v *JsonValue) UnmarshalJSON(data []byte) error

type LaboratoriesExecutionsRequestLaboratoryExecutionCreateParams ¶ 

type LaboratoriesExecutionsRequestLaboratoryExecutionCreateParams struct {
	// Builder agents — at least one required.
	BuilderAgents []AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional `json:"builder_agents"`
	// Continuation from a previous builder completion, as a base64-encoded string.
	BuilderContinuation *string `json:"builder_continuation,omitempty"`
	// Messages for builder agents.
	BuilderMessages []AgentCompletionsMessageMessage `json:"builder_messages"`
	// Docker image to use for builder containers.
	DockerImage string `json:"docker_image"`
	// Evaluation agent for evaluating builder outputs. If not provided,
	// no evaluation is performed.
	EvaluationAgent *AgentInlineAgentBaseWithFallbacksOrRemoteCommitOptional `json:"evaluation_agent,omitempty"`
	// Continuation from a previous evaluation completion, as a base64-encoded string.
	EvaluationContinuation *string `json:"evaluation_continuation,omitempty"`
	// Messages for the evaluation agent.
	EvaluationMessages *[]AgentCompletionsMessageMessage `json:"evaluation_messages,omitempty"`
	// Output schema for evaluation.
	EvaluationOutputSchema *FunctionsExpressionInputSchema `json:"evaluation_output_schema,omitempty"`
	// Maximum number of evaluation retries if validation fails.
	// Defaults to 3 if not specified.
	MaxEvaluationRetries *uint32 `json:"max_evaluation_retries,omitempty" validate:"omitempty,min=0,max=4294967295"`
	// Whether to keep containers after execution. Defaults to false.
	Persist  *bool                            `json:"persist,omitempty"`
	Provider *AgentCompletionsRequestProvider `json:"provider,omitempty"`
	Seed     *int64                           `json:"seed,omitempty" validate:"omitempty,min=-9223372036854775808,max=9223372036854775807"`
	Stream   *bool                            `json:"stream,omitempty"`
}

Parameters for creating a laboratory execution.

func (LaboratoriesExecutionsRequestLaboratoryExecutionCreateParams) SchemaTitle ¶ 

func (LaboratoriesExecutionsRequestLaboratoryExecutionCreateParams) SchemaTitle() string

func (*LaboratoriesExecutionsRequestLaboratoryExecutionCreateParams) UnmarshalJSON ¶ 

func (v *LaboratoriesExecutionsRequestLaboratoryExecutionCreateParams) UnmarshalJSON(data []byte) error

func (LaboratoriesExecutionsRequestLaboratoryExecutionCreateParams) Validate ¶ 

func (v LaboratoriesExecutionsRequestLaboratoryExecutionCreateParams) Validate() error

type LaboratoriesExecutionsResponseStreamingBuilderChunk ¶ 

type LaboratoriesExecutionsResponseStreamingBuilderChunk struct {
	// Agent index (0-based).
	AgentIndex uint64 `json:"agent_index" validate:"min=0,max=18446744073709551615"`
	// Continuation state for multi-turn conversations (only present in the final chunk).
	Continuation *string `json:"continuation,omitempty"`
	Created      uint64  `json:"created" validate:"min=0,max=18446744073709551615"`
	// Error details if this completion failed.
	Error *ErrorResponseError `json:"error,omitempty"`
	ID    string              `json:"id"`
	// Builder index (0-based).
	Index    uint64                                          `json:"index" validate:"min=0,max=18446744073709551615"`
	Messages []AgentCompletionsResponseStreamingMessageChunk `json:"messages"`
	// The object type (always "agent.completion.chunk").
	Object AgentCompletionsResponseStreamingObject `json:"object"`
	// Upstream provider
	Upstream AgentUpstream `json:"upstream"`
	// Token usage (only present in the final chunk).
	Usage *AgentCompletionsResponseUsage `json:"usage,omitempty"`
}

Streaming chunk for a single builder agent completion within a laboratory execution.

func (*LaboratoriesExecutionsResponseStreamingBuilderChunk) Push ¶ 

func (v *LaboratoriesExecutionsResponseStreamingBuilderChunk) Push(other *LaboratoriesExecutionsResponseStreamingBuilderChunk)

Push accumulates another BuilderChunk into this one.

func (LaboratoriesExecutionsResponseStreamingBuilderChunk) SchemaTitle ¶ 

func (LaboratoriesExecutionsResponseStreamingBuilderChunk) SchemaTitle() string

func (*LaboratoriesExecutionsResponseStreamingBuilderChunk) UnmarshalJSON ¶ 

func (v *LaboratoriesExecutionsResponseStreamingBuilderChunk) UnmarshalJSON(data []byte) error

func (LaboratoriesExecutionsResponseStreamingBuilderChunk) Validate ¶ 

func (v LaboratoriesExecutionsResponseStreamingBuilderChunk) Validate() error

type LaboratoriesExecutionsResponseStreamingEvaluationChunk ¶ 

type LaboratoriesExecutionsResponseStreamingEvaluationChunk struct {
	// Agent index (0-based).
	AgentIndex uint64 `json:"agent_index" validate:"min=0,max=18446744073709551615"`
	// Continuation state for multi-turn conversations (only present in the final chunk).
	Continuation *string `json:"continuation,omitempty"`
	Created      uint64  `json:"created" validate:"min=0,max=18446744073709551615"`
	// Error details if this completion failed.
	Error *ErrorResponseError `json:"error,omitempty"`
	ID    string              `json:"id"`
	// Evaluation index (0-based).
	Index    uint64                                          `json:"index" validate:"min=0,max=18446744073709551615"`
	Messages []AgentCompletionsResponseStreamingMessageChunk `json:"messages"`
	// The object type (always "agent.completion.chunk").
	Object AgentCompletionsResponseStreamingObject `json:"object"`
	Output *FunctionsExpressionInputValue          `json:"output,omitempty"`
	// Upstream provider
	Upstream AgentUpstream `json:"upstream"`
	// Token usage (only present in the final chunk).
	Usage *AgentCompletionsResponseUsage `json:"usage,omitempty"`
}

Streaming chunk for a single evaluation agent completion within a laboratory execution.

func (*LaboratoriesExecutionsResponseStreamingEvaluationChunk) Push ¶ 

func (v *LaboratoriesExecutionsResponseStreamingEvaluationChunk) Push(other *LaboratoriesExecutionsResponseStreamingEvaluationChunk)

Push accumulates another EvaluationChunk into this one.

func (LaboratoriesExecutionsResponseStreamingEvaluationChunk) SchemaTitle ¶ 

func (LaboratoriesExecutionsResponseStreamingEvaluationChunk) SchemaTitle() string

func (*LaboratoriesExecutionsResponseStreamingEvaluationChunk) UnmarshalJSON ¶ 

func (v *LaboratoriesExecutionsResponseStreamingEvaluationChunk) UnmarshalJSON(data []byte) error

func (LaboratoriesExecutionsResponseStreamingEvaluationChunk) Validate ¶ 

func (v LaboratoriesExecutionsResponseStreamingEvaluationChunk) Validate() error

type LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk ¶ 

type LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk struct {
	Builders    []LaboratoriesExecutionsResponseStreamingBuilderChunk    `json:"builders"`
	Created     uint64                                                   `json:"created" validate:"min=0,max=18446744073709551615"`
	Error       *ErrorResponseError                                      `json:"error,omitempty"`
	Evaluations []LaboratoriesExecutionsResponseStreamingEvaluationChunk `json:"evaluations"`
	ID          string                                                   `json:"id"`
	Object      LaboratoriesExecutionsResponseStreamingObject            `json:"object"`
	Usage       *AgentCompletionsResponseUsage                           `json:"usage,omitempty"`
}

Streaming chunk for a laboratory execution.

func GenerateLaboratoryExecutionChunk ¶ 

func GenerateLaboratoryExecutionChunk(hasSeed bool, seed int64) (*LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk, error)

GenerateLaboratoryExecutionChunk generates a random LaboratoryExecutionChunk from a seed.

func LaboratoryExecutionChunkMerged ¶ 

func LaboratoryExecutionChunkMerged(a, b LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk) (*LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk, error)

LaboratoryExecutionChunkMerged merges two LaboratoryExecutionChunks via push.

func LaboratoryExecutionChunkNormalized ¶ 

func LaboratoryExecutionChunkNormalized(chunk LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk) (*LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk, error)

LaboratoryExecutionChunkNormalized normalizes a LaboratoryExecutionChunk.

func (*LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk) Push ¶ 

func (v *LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk) Push(other *LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk)

Push accumulates another LaboratoryExecutionChunk into this one.

func (LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk) SchemaTitle ¶ 

func (LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk) SchemaTitle() string

func (*LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk) UnmarshalJSON ¶ 

func (v *LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk) UnmarshalJSON(data []byte) error

func (LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk) Validate ¶ 

func (v LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk) Validate() error

type LaboratoriesExecutionsResponseStreamingObject ¶ 

type LaboratoriesExecutionsResponseStreamingObject struct {
	LaboratoryExecutionChunk string `validate:"omitempty,oneof=laboratory.execution.chunk"`
}

func (LaboratoriesExecutionsResponseStreamingObject) MarshalJSON ¶ 

func (v LaboratoriesExecutionsResponseStreamingObject) MarshalJSON() ([]byte, error)

func (LaboratoriesExecutionsResponseStreamingObject) SchemaTitle ¶ 

func (LaboratoriesExecutionsResponseStreamingObject) SchemaTitle() string

func (*LaboratoriesExecutionsResponseStreamingObject) UnmarshalJSON ¶ 

func (v *LaboratoriesExecutionsResponseStreamingObject) UnmarshalJSON(data []byte) error

func (LaboratoriesExecutionsResponseStreamingObject) Validate ¶ 

func (v LaboratoriesExecutionsResponseStreamingObject) Validate() error

type LaboratoriesExecutionsResponseUnaryBuilder ¶ 

type LaboratoriesExecutionsResponseUnaryBuilder struct {
	// Agent index (0-based).
	AgentIndex uint64 `json:"agent_index" validate:"min=0,max=18446744073709551615"`
	// Continuation state for multi-turn conversations.
	Continuation *string `json:"continuation"`
	Created      uint64  `json:"created" validate:"min=0,max=18446744073709551615"`
	// Error details if this completion failed.
	Error *ErrorResponseError `json:"error"`
	ID    string              `json:"id"`
	// Builder index (0-based).
	Index    uint64                                 `json:"index" validate:"min=0,max=18446744073709551615"`
	Messages []AgentCompletionsResponseUnaryMessage `json:"messages"`
	// The object type (always "agent.completion").
	Object AgentCompletionsResponseUnaryObject `json:"object"`
	// Upstream provider
	Upstream AgentUpstream                 `json:"upstream"`
	Usage    AgentCompletionsResponseUsage `json:"usage"`
}

A single builder agent completion within a laboratory execution (non-streaming).

func (LaboratoriesExecutionsResponseUnaryBuilder) SchemaTitle ¶ 

func (LaboratoriesExecutionsResponseUnaryBuilder) SchemaTitle() string

func (*LaboratoriesExecutionsResponseUnaryBuilder) UnmarshalJSON ¶ 

func (v *LaboratoriesExecutionsResponseUnaryBuilder) UnmarshalJSON(data []byte) error

func (LaboratoriesExecutionsResponseUnaryBuilder) Validate ¶ 

func (v LaboratoriesExecutionsResponseUnaryBuilder) Validate() error

type LaboratoriesExecutionsResponseUnaryEvaluation ¶ 

type LaboratoriesExecutionsResponseUnaryEvaluation struct {
	// Agent index (0-based).
	AgentIndex uint64 `json:"agent_index" validate:"min=0,max=18446744073709551615"`
	// Continuation state for multi-turn conversations.
	Continuation *string `json:"continuation"`
	Created      uint64  `json:"created" validate:"min=0,max=18446744073709551615"`
	// Error details if this completion failed.
	Error *ErrorResponseError `json:"error"`
	ID    string              `json:"id"`
	// Evaluation index (0-based).
	Index    uint64                                 `json:"index" validate:"min=0,max=18446744073709551615"`
	Messages []AgentCompletionsResponseUnaryMessage `json:"messages"`
	// The object type (always "agent.completion").
	Object AgentCompletionsResponseUnaryObject `json:"object"`
	Output *FunctionsExpressionInputValue      `json:"output"`
	// Upstream provider
	Upstream AgentUpstream                 `json:"upstream"`
	Usage    AgentCompletionsResponseUsage `json:"usage"`
}

A single evaluation agent completion within a laboratory execution (non-streaming).

func (LaboratoriesExecutionsResponseUnaryEvaluation) SchemaTitle ¶ 

func (LaboratoriesExecutionsResponseUnaryEvaluation) SchemaTitle() string

func (*LaboratoriesExecutionsResponseUnaryEvaluation) UnmarshalJSON ¶ 

func (v *LaboratoriesExecutionsResponseUnaryEvaluation) UnmarshalJSON(data []byte) error

func (LaboratoriesExecutionsResponseUnaryEvaluation) Validate ¶ 

func (v LaboratoriesExecutionsResponseUnaryEvaluation) Validate() error

type LaboratoriesExecutionsResponseUnaryLaboratoryExecution ¶ 

type LaboratoriesExecutionsResponseUnaryLaboratoryExecution struct {
	// Results from each builder agent completion.
	Builders []LaboratoriesExecutionsResponseUnaryBuilder `json:"builders"`
	// Unix timestamp when the execution was created.
	Created uint64 `json:"created" validate:"min=0,max=18446744073709551615"`
	// Error details if the execution failed.
	Error *ErrorResponseError `json:"error"`
	// Results from each evaluation agent completion.
	Evaluations []LaboratoriesExecutionsResponseUnaryEvaluation `json:"evaluations"`
	// Unique identifier for this execution.
	ID string `json:"id"`
	// Object type identifier.
	Object LaboratoriesExecutionsResponseUnaryObject `json:"object"`
	// Aggregated token and cost usage.
	Usage AgentCompletionsResponseUsage `json:"usage"`
}

A complete laboratory execution response (non-streaming).

func LaboratoriesExecutionsCreateLaboratoryExecutionUnary ¶ 

func LaboratoriesExecutionsCreateLaboratoryExecutionUnary(ctx context.Context, c *Client, params LaboratoriesExecutionsRequestLaboratoryExecutionCreateParams) (*LaboratoriesExecutionsResponseUnaryLaboratoryExecution, error)

func LaboratoryExecutionChunkToUnary ¶ 

func LaboratoryExecutionChunkToUnary(chunk LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk) (*LaboratoriesExecutionsResponseUnaryLaboratoryExecution, error)

LaboratoryExecutionChunkToUnary converts an accumulated chunk to a unary LaboratoryExecution.

func NormalizeLaboratoryExecutionForTests ¶ 

func NormalizeLaboratoryExecutionForTests(v LaboratoriesExecutionsResponseUnaryLaboratoryExecution) (*LaboratoriesExecutionsResponseUnaryLaboratoryExecution, error)

NormalizeLaboratoryExecutionForTests normalizes a LaboratoryExecution by round-tripping through serde.

func (LaboratoriesExecutionsResponseUnaryLaboratoryExecution) SchemaTitle ¶ 

func (LaboratoriesExecutionsResponseUnaryLaboratoryExecution) SchemaTitle() string

func (*LaboratoriesExecutionsResponseUnaryLaboratoryExecution) UnmarshalJSON ¶ 

func (v *LaboratoriesExecutionsResponseUnaryLaboratoryExecution) UnmarshalJSON(data []byte) error

func (LaboratoriesExecutionsResponseUnaryLaboratoryExecution) Validate ¶ 

func (v LaboratoriesExecutionsResponseUnaryLaboratoryExecution) Validate() error

type LaboratoriesExecutionsResponseUnaryObject ¶ 

type LaboratoriesExecutionsResponseUnaryObject struct {
	LaboratoryExecution string `validate:"omitempty,oneof=laboratory.execution"`
}

func (LaboratoriesExecutionsResponseUnaryObject) MarshalJSON ¶ 

func (v LaboratoriesExecutionsResponseUnaryObject) MarshalJSON() ([]byte, error)

func (LaboratoriesExecutionsResponseUnaryObject) SchemaTitle ¶ 

func (LaboratoriesExecutionsResponseUnaryObject) SchemaTitle() string

func (*LaboratoriesExecutionsResponseUnaryObject) UnmarshalJSON ¶ 

func (v *LaboratoriesExecutionsResponseUnaryObject) UnmarshalJSON(data []byte) error

func (LaboratoriesExecutionsResponseUnaryObject) Validate ¶ 

func (v LaboratoriesExecutionsResponseUnaryObject) Validate() error

type McpCompletionsCapability ¶ 

type McpCompletionsCapability struct{}

Marker capability for completions support. Presence indicates the server supports argument value completions.

func (McpCompletionsCapability) AdditionalProperties ¶ 

func (McpCompletionsCapability) AdditionalProperties() bool

func (McpCompletionsCapability) SchemaTitle ¶ 

func (McpCompletionsCapability) SchemaTitle() string

type McpImplementation ¶ 

type McpImplementation struct {
	// Optional description.
	Description *string `json:"description,omitempty"`
	// Optional icons for UI display.
	Icons *[]McpSharedIcon `json:"icons,omitempty"`
	// The implementation name.
	Name string `json:"name"`
	// Human-readable title.
	Title *string `json:"title,omitempty"`
	// The implementation version.
	Version string `json:"version"`
	// Optional website URL.
	WebsiteUrl *string `json:"websiteUrl,omitempty"`
}

Information about a client or server implementation.

func (McpImplementation) SchemaTitle ¶ 

func (McpImplementation) SchemaTitle() string

func (*McpImplementation) UnmarshalJSON ¶ 

func (v *McpImplementation) UnmarshalJSON(data []byte) error

func (McpImplementation) Validate ¶ 

func (v McpImplementation) Validate() error

type McpInitializeResult ¶ 

type McpInitializeResult struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// The server's supported capabilities.
	Capabilities McpServerCapabilities `json:"capabilities"`
	// Optional instructions for LLM integration.
	Instructions *string `json:"instructions,omitempty"`
	// The MCP protocol version the server wants to use.
	ProtocolVersion string `json:"protocolVersion"`
	// Information about the server implementation.
	ServerInfo McpImplementation `json:"serverInfo"`
}

The server's response to an `initialize` request.

func (McpInitializeResult) SchemaTitle ¶ 

func (McpInitializeResult) SchemaTitle() string

func (*McpInitializeResult) UnmarshalJSON ¶ 

func (v *McpInitializeResult) UnmarshalJSON(data []byte) error

func (McpInitializeResult) Validate ¶ 

func (v McpInitializeResult) Validate() error

type McpJsonRpcError ¶ 

type McpJsonRpcError struct {
	Code    int64     `json:"code" validate:"min=-9223372036854775808,max=9223372036854775807"`
	Data    JsonValue `json:"data,omitempty"`
	Message string    `json:"message"`
}

JSON-RPC 2.0 error object.

func (McpJsonRpcError) SchemaTitle ¶ 

func (McpJsonRpcError) SchemaTitle() string

func (*McpJsonRpcError) UnmarshalJSON ¶ 

func (v *McpJsonRpcError) UnmarshalJSON(data []byte) error

func (McpJsonRpcError) Validate ¶ 

func (v McpJsonRpcError) Validate() error

type McpJsonRpcNotification ¶ 

type McpJsonRpcNotification struct {
	Jsonrpc string    `json:"jsonrpc"`
	Method  string    `json:"method"`
	Params  JsonValue `json:"params,omitempty"`
}

JSON-RPC 2.0 notification (no `id` field).

func (McpJsonRpcNotification) SchemaTitle ¶ 

func (McpJsonRpcNotification) SchemaTitle() string

func (*McpJsonRpcNotification) UnmarshalJSON ¶ 

func (v *McpJsonRpcNotification) UnmarshalJSON(data []byte) error

func (McpJsonRpcNotification) Validate ¶ 

func (v McpJsonRpcNotification) Validate() error

type McpJsonRpcRequest ¶ 

type McpJsonRpcRequest struct {
	ID      JsonValue `json:"id"`
	Jsonrpc string    `json:"jsonrpc"`
	Method  string    `json:"method"`
	Params  JsonValue `json:"params" default:"null"`
}

JSON-RPC 2.0 inbound request.

func (McpJsonRpcRequest) SchemaTitle ¶ 

func (McpJsonRpcRequest) SchemaTitle() string

func (*McpJsonRpcRequest) UnmarshalJSON ¶ 

func (v *McpJsonRpcRequest) UnmarshalJSON(data []byte) error

func (McpJsonRpcRequest) Validate ¶ 

func (v McpJsonRpcRequest) Validate() error

type McpLoggingCapability ¶ 

type McpLoggingCapability struct{}

Marker capability for logging support. Presence indicates the server supports sending log messages to the client.

func (McpLoggingCapability) AdditionalProperties ¶ 

func (McpLoggingCapability) AdditionalProperties() bool

func (McpLoggingCapability) SchemaTitle ¶ 

func (McpLoggingCapability) SchemaTitle() string

type McpPromptsCapability ¶ 

type McpPromptsCapability struct {
	// Whether the server emits notifications when the prompt list changes.
	ListChanged *bool `json:"listChanged,omitempty"`
}

Capabilities for prompt templates.

func (McpPromptsCapability) SchemaTitle ¶ 

func (McpPromptsCapability) SchemaTitle() string

func (McpPromptsCapability) Validate ¶ 

func (v McpPromptsCapability) Validate() error

type McpResourceListResourcesRequest ¶ 

type McpResourceListResourcesRequest struct {
	// An opaque cursor for pagination.
	Cursor *string `json:"cursor,omitempty"`
}

Parameters for a `resources/list` request.

func (McpResourceListResourcesRequest) SchemaTitle ¶ 

func (McpResourceListResourcesRequest) SchemaTitle() string

func (McpResourceListResourcesRequest) Validate ¶ 

func (v McpResourceListResourcesRequest) Validate() error

type McpResourceListResourcesResult ¶ 

type McpResourceListResourcesResult struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// An opaque cursor for fetching the next page.
	NextCursor *string `json:"nextCursor,omitempty"`
	// The list of resources available on the server.
	Resources []McpResourceResource `json:"resources"`
}

The server's response to a `resources/list` request.

func (McpResourceListResourcesResult) SchemaTitle ¶ 

func (McpResourceListResourcesResult) SchemaTitle() string

func (*McpResourceListResourcesResult) UnmarshalJSON ¶ 

func (v *McpResourceListResourcesResult) UnmarshalJSON(data []byte) error

func (McpResourceListResourcesResult) Validate ¶ 

func (v McpResourceListResourcesResult) Validate() error

type McpResourceReadResourceRequestParams ¶ 

type McpResourceReadResourceRequestParams struct {
	// The URI of the resource to read.
	URI string `json:"uri"`
}

Parameters for a `resources/read` request.

func (McpResourceReadResourceRequestParams) SchemaTitle ¶ 

func (McpResourceReadResourceRequestParams) SchemaTitle() string

func (*McpResourceReadResourceRequestParams) UnmarshalJSON ¶ 

func (v *McpResourceReadResourceRequestParams) UnmarshalJSON(data []byte) error

func (McpResourceReadResourceRequestParams) Validate ¶ 

func (v McpResourceReadResourceRequestParams) Validate() error

type McpResourceReadResourceResult ¶ 

type McpResourceReadResourceResult struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// The contents of the resource.
	Contents []McpSharedResourceContentsUnion `json:"contents"`
}

The server's response to a `resources/read` request.

func (McpResourceReadResourceResult) SchemaTitle ¶ 

func (McpResourceReadResourceResult) SchemaTitle() string

func (*McpResourceReadResourceResult) UnmarshalJSON ¶ 

func (v *McpResourceReadResourceResult) UnmarshalJSON(data []byte) error

func (McpResourceReadResourceResult) Validate ¶ 

func (v McpResourceReadResourceResult) Validate() error

type McpResourceResource ¶ 

type McpResourceResource struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// Optional annotations for the client.
	Annotations *McpSharedAnnotations `json:"annotations,omitempty"`
	// A description of what this resource represents.
	Description *string `json:"description,omitempty"`
	// Icons for the resource.
	Icons *[]McpSharedIcon `json:"icons,omitempty"`
	// The MIME type of this resource, if known.
	MimeType *string `json:"mimeType,omitempty"`
	// The programmatic name of the resource.
	Name string `json:"name"`
	// A human-readable display name.
	Title *string `json:"title,omitempty"`
	// The URI of this resource.
	URI string `json:"uri"`
}

A known resource that the server is capable of reading.

func (McpResourceResource) SchemaTitle ¶ 

func (McpResourceResource) SchemaTitle() string

func (*McpResourceResource) UnmarshalJSON ¶ 

func (v *McpResourceResource) UnmarshalJSON(data []byte) error

func (McpResourceResource) Validate ¶ 

func (v McpResourceResource) Validate() error

type McpResourcesCapability ¶ 

type McpResourcesCapability struct {
	// Whether the server emits notifications when the resource list changes.
	ListChanged *bool `json:"listChanged,omitempty"`
	// Whether the server supports resource subscriptions.
	Subscribe *bool `json:"subscribe,omitempty"`
}

Capabilities for resources.

func (McpResourcesCapability) SchemaTitle ¶ 

func (McpResourcesCapability) SchemaTitle() string

func (McpResourcesCapability) Validate ¶ 

func (v McpResourcesCapability) Validate() error

type McpServerCapabilities ¶ 

type McpServerCapabilities struct {
	// Completions support. Presence indicates the server supports completions.
	Completions *McpCompletionsCapability `json:"completions,omitempty"`
	// Non-standard experimental capabilities.
	Experimental *OrderedMap[string, JsonValue] `json:"experimental,omitempty"`
	// Logging support. Presence indicates the server supports sending log messages.
	Logging *McpLoggingCapability `json:"logging,omitempty"`
	// Prompt template capabilities.
	Prompts *McpPromptsCapability `json:"prompts,omitempty"`
	// Resource capabilities.
	Resources *McpResourcesCapability `json:"resources,omitempty"`
	// Task capabilities.
	Tasks *McpTasksCapability `json:"tasks,omitempty"`
	// Tool capabilities.
	Tools *McpToolsCapability `json:"tools,omitempty"`
}

Capabilities that an MCP server may support.

func (McpServerCapabilities) SchemaTitle ¶ 

func (McpServerCapabilities) SchemaTitle() string

func (McpServerCapabilities) Validate ¶ 

func (v McpServerCapabilities) Validate() error

type McpSharedAnnotations ¶ 

type McpSharedAnnotations struct {
	// Intended audience(s) for the content.
	Audience *[]McpSharedRole `json:"audience,omitempty"`
	// ISO 8601 timestamp for the most recent modification.
	LastModified *string `json:"lastModified,omitempty"`
	// Importance hint, from 0 (least) to 1 (most).
	Priority *float64 `json:"priority,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

Optional annotations providing clients additional context about content.

func (McpSharedAnnotations) SchemaTitle ¶ 

func (McpSharedAnnotations) SchemaTitle() string

func (McpSharedAnnotations) Validate ¶ 

func (v McpSharedAnnotations) Validate() error

type McpSharedBlobResourceContents ¶ 

type McpSharedBlobResourceContents struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// A base64-encoded string representing the binary data.
	Blob string `json:"blob"`
	// The MIME type of this resource, if known.
	MimeType *string `json:"mimeType,omitempty"`
	// The URI of this resource.
	URI string `json:"uri"`
}

Binary resource contents (base64-encoded).

func (McpSharedBlobResourceContents) SchemaTitle ¶ 

func (McpSharedBlobResourceContents) SchemaTitle() string

func (*McpSharedBlobResourceContents) UnmarshalJSON ¶ 

func (v *McpSharedBlobResourceContents) UnmarshalJSON(data []byte) error

func (McpSharedBlobResourceContents) Validate ¶ 

func (v McpSharedBlobResourceContents) Validate() error

type McpSharedIcon ¶ 

type McpSharedIcon struct {
	// MIME type for the icon.
	MimeType *string `json:"mimeType,omitempty"`
	// Sizes at which the icon can be used (e.g., "48x48", "96x96", "any").
	Sizes *[]string `json:"sizes,omitempty"`
	// URL or data URI for the icon.
	Src string `json:"src"`
	// Theme this icon is intended for.
	Theme *McpSharedIconTheme `json:"theme,omitempty"`
}

An icon that can be displayed in a user interface.

func (McpSharedIcon) SchemaTitle ¶ 

func (McpSharedIcon) SchemaTitle() string

func (*McpSharedIcon) UnmarshalJSON ¶ 

func (v *McpSharedIcon) UnmarshalJSON(data []byte) error

func (McpSharedIcon) Validate ¶ 

func (v McpSharedIcon) Validate() error

type McpSharedIconTheme ¶ 

type McpSharedIconTheme struct {
	Light *McpSharedIconThemeLight `validate:"omitempty,oneof=light"`
	Dark  *McpSharedIconThemeDark  `validate:"omitempty,oneof=dark"`
}

Theme preference for an icon.

func (McpSharedIconTheme) MarshalJSON ¶ 

func (v McpSharedIconTheme) MarshalJSON() ([]byte, error)

func (McpSharedIconTheme) SchemaTitle ¶ 

func (McpSharedIconTheme) SchemaTitle() string

func (*McpSharedIconTheme) UnmarshalJSON ¶ 

func (v *McpSharedIconTheme) UnmarshalJSON(data []byte) error

func (McpSharedIconTheme) Validate ¶ 

func (v McpSharedIconTheme) Validate() error

type McpSharedIconThemeDark ¶ 

type McpSharedIconThemeDark string

func (McpSharedIconThemeDark) SchemaVariantTitle ¶ 

func (McpSharedIconThemeDark) SchemaVariantTitle() string

type McpSharedIconThemeLight ¶ 

type McpSharedIconThemeLight string

func (McpSharedIconThemeLight) SchemaVariantTitle ¶ 

func (McpSharedIconThemeLight) SchemaVariantTitle() string

type McpSharedResourceContents ¶ 

type McpSharedResourceContents struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// The MIME type of this resource, if known.
	MimeType *string `json:"mimeType,omitempty"`
	// The URI of this resource.
	URI string `json:"uri"`
}

Base fields shared by all resource contents.

func (McpSharedResourceContents) SchemaTitle ¶ 

func (McpSharedResourceContents) SchemaTitle() string

func (*McpSharedResourceContents) UnmarshalJSON ¶ 

func (v *McpSharedResourceContents) UnmarshalJSON(data []byte) error

func (McpSharedResourceContents) Validate ¶ 

func (v McpSharedResourceContents) Validate() error

type McpSharedResourceContentsUnion ¶ 

type McpSharedResourceContentsUnion struct {
	Text *McpSharedTextResourceContents
	Blob *McpSharedBlobResourceContents
}

Either text or blob resource contents.

func (McpSharedResourceContentsUnion) MarshalJSON ¶ 

func (v McpSharedResourceContentsUnion) MarshalJSON() ([]byte, error)

func (McpSharedResourceContentsUnion) SchemaTitle ¶ 

func (McpSharedResourceContentsUnion) SchemaTitle() string

func (*McpSharedResourceContentsUnion) UnmarshalJSON ¶ 

func (v *McpSharedResourceContentsUnion) UnmarshalJSON(data []byte) error

func (McpSharedResourceContentsUnion) Validate ¶ 

func (v McpSharedResourceContentsUnion) Validate() error

type McpSharedRole ¶ 

type McpSharedRole struct {
	User      *McpSharedRoleUser      `validate:"omitempty,oneof=user"`
	Assistant *McpSharedRoleAssistant `validate:"omitempty,oneof=assistant"`
}

The role of a message sender.

func (McpSharedRole) MarshalJSON ¶ 

func (v McpSharedRole) MarshalJSON() ([]byte, error)

func (McpSharedRole) SchemaTitle ¶ 

func (McpSharedRole) SchemaTitle() string

func (*McpSharedRole) UnmarshalJSON ¶ 

func (v *McpSharedRole) UnmarshalJSON(data []byte) error

func (McpSharedRole) Validate ¶ 

func (v McpSharedRole) Validate() error

type McpSharedRoleAssistant ¶ 

type McpSharedRoleAssistant string

func (McpSharedRoleAssistant) SchemaVariantTitle ¶ 

func (McpSharedRoleAssistant) SchemaVariantTitle() string

type McpSharedRoleUser ¶ 

type McpSharedRoleUser string

func (McpSharedRoleUser) SchemaVariantTitle ¶ 

func (McpSharedRoleUser) SchemaVariantTitle() string

type McpSharedTextResourceContents ¶ 

type McpSharedTextResourceContents struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// The MIME type of this resource, if known.
	MimeType *string `json:"mimeType,omitempty"`
	// The text of the item.
	Text string `json:"text"`
	// The URI of this resource.
	URI string `json:"uri"`
}

Text resource contents.

func (McpSharedTextResourceContents) SchemaTitle ¶ 

func (McpSharedTextResourceContents) SchemaTitle() string

func (*McpSharedTextResourceContents) UnmarshalJSON ¶ 

func (v *McpSharedTextResourceContents) UnmarshalJSON(data []byte) error

func (McpSharedTextResourceContents) Validate ¶ 

func (v McpSharedTextResourceContents) Validate() error

type McpTasksCancelCapability ¶ 

type McpTasksCancelCapability struct{}

Marker capability for task cancellation support.

func (McpTasksCancelCapability) AdditionalProperties ¶ 

func (McpTasksCancelCapability) AdditionalProperties() bool

func (McpTasksCancelCapability) SchemaTitle ¶ 

func (McpTasksCancelCapability) SchemaTitle() string

type McpTasksCapability ¶ 

type McpTasksCapability struct {
	// Present if the server supports cancelling tasks.
	Cancel *McpTasksCancelCapability `json:"cancel,omitempty"`
	// Present if the server supports listing tasks.
	List *McpTasksListCapability `json:"list,omitempty"`
	// Task creation capabilities for specific request types.
	Requests *McpTasksRequestsCapability `json:"requests,omitempty"`
}

Capabilities for task creation and management.

func (McpTasksCapability) SchemaTitle ¶ 

func (McpTasksCapability) SchemaTitle() string

func (McpTasksCapability) Validate ¶ 

func (v McpTasksCapability) Validate() error

type McpTasksListCapability ¶ 

type McpTasksListCapability struct{}

Marker capability for task listing support.

func (McpTasksListCapability) AdditionalProperties ¶ 

func (McpTasksListCapability) AdditionalProperties() bool

func (McpTasksListCapability) SchemaTitle ¶ 

func (McpTasksListCapability) SchemaTitle() string

type McpTasksRequestsCapability ¶ 

type McpTasksRequestsCapability struct {
	// Task support for tool-related requests.
	Tools *McpTasksToolsCapability `json:"tools,omitempty"`
}

Task creation capabilities scoped to request types.

func (McpTasksRequestsCapability) SchemaTitle ¶ 

func (McpTasksRequestsCapability) SchemaTitle() string

func (McpTasksRequestsCapability) Validate ¶ 

func (v McpTasksRequestsCapability) Validate() error

type McpTasksToolsCallCapability ¶ 

type McpTasksToolsCallCapability struct{}

Marker capability for tools/call task creation support.

func (McpTasksToolsCallCapability) AdditionalProperties ¶ 

func (McpTasksToolsCallCapability) AdditionalProperties() bool

func (McpTasksToolsCallCapability) SchemaTitle ¶ 

func (McpTasksToolsCallCapability) SchemaTitle() string

type McpTasksToolsCapability ¶ 

type McpTasksToolsCapability struct {
	// Present if tools/call supports task creation.
	Call *McpTasksToolsCallCapability `json:"call,omitempty"`
}

Task capabilities for tool requests.

func (McpTasksToolsCapability) SchemaTitle ¶ 

func (McpTasksToolsCapability) SchemaTitle() string

func (McpTasksToolsCapability) Validate ¶ 

func (v McpTasksToolsCapability) Validate() error

type McpToolAudioContent ¶ 

type McpToolAudioContent struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// Optional annotations for the client.
	Annotations *McpSharedAnnotations `json:"annotations,omitempty"`
	// The base64-encoded audio data.
	Data string `json:"data"`
	// The MIME type of the audio.
	MimeType string `json:"mimeType"`
}

Audio content (base64-encoded).

func (McpToolAudioContent) SchemaTitle ¶ 

func (McpToolAudioContent) SchemaTitle() string

func (*McpToolAudioContent) UnmarshalJSON ¶ 

func (v *McpToolAudioContent) UnmarshalJSON(data []byte) error

func (McpToolAudioContent) Validate ¶ 

func (v McpToolAudioContent) Validate() error

type McpToolCallToolRequestParams ¶ 

type McpToolCallToolRequestParams struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// Arguments to pass to the tool.
	Arguments *OrderedMap[string, JsonValue] `json:"arguments,omitempty"`
	// The name of the tool to call.
	Name string `json:"name"`
	// If specified, the caller is requesting task-augmented execution.
	Task *McpToolTaskMetadata `json:"task,omitempty"`
}

Parameters for a `tools/call` request.

func (McpToolCallToolRequestParams) SchemaTitle ¶ 

func (McpToolCallToolRequestParams) SchemaTitle() string

func (*McpToolCallToolRequestParams) UnmarshalJSON ¶ 

func (v *McpToolCallToolRequestParams) UnmarshalJSON(data []byte) error

func (McpToolCallToolRequestParams) Validate ¶ 

func (v McpToolCallToolRequestParams) Validate() error

type McpToolCallToolResult ¶ 

type McpToolCallToolResult struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// Content blocks representing the result of the tool call.
	Content []McpToolContentBlock `json:"content" default:"[]"`
	// Whether the tool call ended in an error.
	IsError *bool `json:"isError,omitempty"`
	// Structured tool output matching the tool's `outputSchema`.
	StructuredContent *OrderedMap[string, JsonValue] `json:"structuredContent,omitempty"`
}

The server's response to a `tools/call` request.

func (McpToolCallToolResult) SchemaTitle ¶ 

func (McpToolCallToolResult) SchemaTitle() string

func (*McpToolCallToolResult) UnmarshalJSON ¶ 

func (v *McpToolCallToolResult) UnmarshalJSON(data []byte) error

func (McpToolCallToolResult) Validate ¶ 

func (v McpToolCallToolResult) Validate() error

type McpToolContentBlock ¶ 

type McpToolContentBlock struct {
	// Text content.
	Text *McpToolContentBlockText
	// Image content (base64-encoded).
	Image *McpToolContentBlockImage
	// Audio content (base64-encoded).
	Audio *McpToolContentBlockAudio
	// A resource link.
	ResourceLink *McpToolContentBlockResourceLink
	// An embedded resource.
	EmbeddedResource *McpToolContentBlockEmbeddedResource
}

A content block that can be used in prompts and tool results.

func (McpToolContentBlock) MarshalJSON ¶ 

func (v McpToolContentBlock) MarshalJSON() ([]byte, error)

func (McpToolContentBlock) SchemaTitle ¶ 

func (McpToolContentBlock) SchemaTitle() string

func (*McpToolContentBlock) UnmarshalJSON ¶ 

func (v *McpToolContentBlock) UnmarshalJSON(data []byte) error

func (McpToolContentBlock) Validate ¶ 

func (v McpToolContentBlock) Validate() error

type McpToolContentBlockAudio ¶ 

type McpToolContentBlockAudio struct {
	McpToolAudioContent
	Type string `json:"type" validate:"oneof=audio"`
}

Audio content (base64-encoded).

func (McpToolContentBlockAudio) MarshalJSON ¶ 

func (v McpToolContentBlockAudio) MarshalJSON() ([]byte, error)

func (McpToolContentBlockAudio) SchemaVariantTitle ¶ 

func (McpToolContentBlockAudio) SchemaVariantTitle() string

func (*McpToolContentBlockAudio) UnmarshalJSON ¶ 

func (v *McpToolContentBlockAudio) UnmarshalJSON(data []byte) error

type McpToolContentBlockEmbeddedResource ¶ 

type McpToolContentBlockEmbeddedResource struct {
	McpToolEmbeddedResource
	Type string `json:"type" validate:"oneof=resource"`
}

An embedded resource.

func (McpToolContentBlockEmbeddedResource) MarshalJSON ¶ 

func (v McpToolContentBlockEmbeddedResource) MarshalJSON() ([]byte, error)

func (McpToolContentBlockEmbeddedResource) SchemaVariantTitle ¶ 

func (McpToolContentBlockEmbeddedResource) SchemaVariantTitle() string

func (*McpToolContentBlockEmbeddedResource) UnmarshalJSON ¶ 

func (v *McpToolContentBlockEmbeddedResource) UnmarshalJSON(data []byte) error

type McpToolContentBlockImage ¶ 

type McpToolContentBlockImage struct {
	McpToolImageContent
	Type string `json:"type" validate:"oneof=image"`
}

Image content (base64-encoded).

func (McpToolContentBlockImage) MarshalJSON ¶ 

func (v McpToolContentBlockImage) MarshalJSON() ([]byte, error)

func (McpToolContentBlockImage) SchemaVariantTitle ¶ 

func (McpToolContentBlockImage) SchemaVariantTitle() string

func (*McpToolContentBlockImage) UnmarshalJSON ¶ 

func (v *McpToolContentBlockImage) UnmarshalJSON(data []byte) error
type McpToolContentBlockResourceLink struct {
	McpToolResourceLink
	Type string `json:"type" validate:"oneof=resource_link"`
}

A resource link.

func (McpToolContentBlockResourceLink) MarshalJSON ¶ 

func (v McpToolContentBlockResourceLink) MarshalJSON() ([]byte, error)

func (McpToolContentBlockResourceLink) SchemaVariantTitle ¶ 

func (McpToolContentBlockResourceLink) SchemaVariantTitle() string

func (*McpToolContentBlockResourceLink) UnmarshalJSON ¶ 

func (v *McpToolContentBlockResourceLink) UnmarshalJSON(data []byte) error

type McpToolContentBlockText ¶ 

type McpToolContentBlockText struct {
	McpToolTextContent
	Type string `json:"type" validate:"oneof=text"`
}

Text content.

func (McpToolContentBlockText) MarshalJSON ¶ 

func (v McpToolContentBlockText) MarshalJSON() ([]byte, error)

func (McpToolContentBlockText) SchemaVariantTitle ¶ 

func (McpToolContentBlockText) SchemaVariantTitle() string

func (*McpToolContentBlockText) UnmarshalJSON ¶ 

func (v *McpToolContentBlockText) UnmarshalJSON(data []byte) error

type McpToolEmbeddedResource ¶ 

type McpToolEmbeddedResource struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// Optional annotations for the client.
	Annotations *McpSharedAnnotations `json:"annotations,omitempty"`
	// The embedded resource contents.
	Resource McpSharedResourceContentsUnion `json:"resource"`
}

The contents of a resource, embedded into a prompt or tool call result.

func (McpToolEmbeddedResource) SchemaTitle ¶ 

func (McpToolEmbeddedResource) SchemaTitle() string

func (*McpToolEmbeddedResource) UnmarshalJSON ¶ 

func (v *McpToolEmbeddedResource) UnmarshalJSON(data []byte) error

func (McpToolEmbeddedResource) Validate ¶ 

func (v McpToolEmbeddedResource) Validate() error

type McpToolImageContent ¶ 

type McpToolImageContent struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// Optional annotations for the client.
	Annotations *McpSharedAnnotations `json:"annotations,omitempty"`
	// The base64-encoded image data.
	Data string `json:"data"`
	// The MIME type of the image.
	MimeType string `json:"mimeType"`
}

Image content (base64-encoded).

func (McpToolImageContent) SchemaTitle ¶ 

func (McpToolImageContent) SchemaTitle() string

func (*McpToolImageContent) UnmarshalJSON ¶ 

func (v *McpToolImageContent) UnmarshalJSON(data []byte) error

func (McpToolImageContent) Validate ¶ 

func (v McpToolImageContent) Validate() error

type McpToolListToolsRequest ¶ 

type McpToolListToolsRequest struct {
	// An opaque cursor for pagination.
	Cursor *string `json:"cursor,omitempty"`
}

Parameters for a `tools/list` request.

func (McpToolListToolsRequest) SchemaTitle ¶ 

func (McpToolListToolsRequest) SchemaTitle() string

func (McpToolListToolsRequest) Validate ¶ 

func (v McpToolListToolsRequest) Validate() error

type McpToolListToolsResult ¶ 

type McpToolListToolsResult struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// An opaque cursor for fetching the next page.
	NextCursor *string `json:"nextCursor,omitempty"`
	// The list of tools available on the server.
	Tools []McpToolTool `json:"tools"`
}

The server's response to a `tools/list` request.

func (McpToolListToolsResult) SchemaTitle ¶ 

func (McpToolListToolsResult) SchemaTitle() string

func (*McpToolListToolsResult) UnmarshalJSON ¶ 

func (v *McpToolListToolsResult) UnmarshalJSON(data []byte) error

func (McpToolListToolsResult) Validate ¶ 

func (v McpToolListToolsResult) Validate() error
type McpToolResourceLink struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// Optional annotations for the client.
	Annotations *McpSharedAnnotations `json:"annotations,omitempty"`
	// A description of what this resource represents.
	Description *string `json:"description,omitempty"`
	// Icons for the resource link.
	Icons *[]McpSharedIcon `json:"icons,omitempty"`
	// The MIME type of this resource, if known.
	MimeType *string `json:"mimeType,omitempty"`
	// The programmatic name of the resource.
	Name string `json:"name"`
	// A human-readable display name.
	Title *string `json:"title,omitempty"`
	// The URI of this resource.
	URI string `json:"uri"`
}

A resource link included in a prompt or tool call result.

func (McpToolResourceLink) SchemaTitle ¶ 

func (McpToolResourceLink) SchemaTitle() string

func (*McpToolResourceLink) UnmarshalJSON ¶ 

func (v *McpToolResourceLink) UnmarshalJSON(data []byte) error

func (McpToolResourceLink) Validate ¶ 

func (v McpToolResourceLink) Validate() error

type McpToolTaskMetadata ¶ 

type McpToolTaskMetadata struct {
	// Time-to-live for the task, in seconds.
	Ttl *float64 `json:"ttl,omitempty" validate:"omitempty,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

Metadata for a long-running task.

func (McpToolTaskMetadata) SchemaTitle ¶ 

func (McpToolTaskMetadata) SchemaTitle() string

func (McpToolTaskMetadata) Validate ¶ 

func (v McpToolTaskMetadata) Validate() error

type McpToolTaskSupport ¶ 

type McpToolTaskSupport struct {
	// Clients MUST invoke the tool as a task.
	Required *McpToolTaskSupportRequired `validate:"omitempty,oneof=required"`
	// Clients MAY invoke the tool as a task or normal request.
	Optional *McpToolTaskSupportOptional `validate:"omitempty,oneof=optional"`
	// Clients MUST NOT attempt to invoke the tool as a task.
	Forbidden *McpToolTaskSupportForbidden `validate:"omitempty,oneof=forbidden"`
}

The tool's preference for task-augmented execution.

func (McpToolTaskSupport) MarshalJSON ¶ 

func (v McpToolTaskSupport) MarshalJSON() ([]byte, error)

func (McpToolTaskSupport) SchemaTitle ¶ 

func (McpToolTaskSupport) SchemaTitle() string

func (*McpToolTaskSupport) UnmarshalJSON ¶ 

func (v *McpToolTaskSupport) UnmarshalJSON(data []byte) error

func (McpToolTaskSupport) Validate ¶ 

func (v McpToolTaskSupport) Validate() error

type McpToolTaskSupportForbidden ¶ 

type McpToolTaskSupportForbidden string

func (McpToolTaskSupportForbidden) SchemaVariantTitle ¶ 

func (McpToolTaskSupportForbidden) SchemaVariantTitle() string

type McpToolTaskSupportOptional ¶ 

type McpToolTaskSupportOptional string

func (McpToolTaskSupportOptional) SchemaVariantTitle ¶ 

func (McpToolTaskSupportOptional) SchemaVariantTitle() string

type McpToolTaskSupportRequired ¶ 

type McpToolTaskSupportRequired string

func (McpToolTaskSupportRequired) SchemaVariantTitle ¶ 

func (McpToolTaskSupportRequired) SchemaVariantTitle() string

type McpToolTextContent ¶ 

type McpToolTextContent struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// Optional annotations for the client.
	Annotations *McpSharedAnnotations `json:"annotations,omitempty"`
	// The text content of the message.
	Text string `json:"text"`
}

Text content.

func (McpToolTextContent) SchemaTitle ¶ 

func (McpToolTextContent) SchemaTitle() string

func (*McpToolTextContent) UnmarshalJSON ¶ 

func (v *McpToolTextContent) UnmarshalJSON(data []byte) error

func (McpToolTextContent) Validate ¶ 

func (v McpToolTextContent) Validate() error

type McpToolTool ¶ 

type McpToolTool struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// Additional tool metadata.
	Annotations *McpToolToolAnnotations `json:"annotations,omitempty"`
	// A human-readable description of the tool.
	Description *string `json:"description,omitempty"`
	// Execution-related properties.
	Execution *McpToolToolExecution `json:"execution,omitempty"`
	// Icons for the tool.
	Icons *[]McpSharedIcon `json:"icons,omitempty"`
	// JSON Schema defining the expected input parameters.
	// Must have `type: "object"` at the root level.
	InputSchema McpToolToolSchemaObject `json:"inputSchema"`
	// The programmatic name of the tool.
	Name string `json:"name"`
	// JSON Schema defining the structure of the tool's output
	// (returned in `structuredContent`).
	OutputSchema *McpToolToolSchemaObject `json:"outputSchema,omitempty"`
	// A human-readable display name.
	Title *string `json:"title,omitempty"`
}

A tool that an MCP server exposes for invocation.

func (McpToolTool) SchemaTitle ¶ 

func (McpToolTool) SchemaTitle() string

func (*McpToolTool) UnmarshalJSON ¶ 

func (v *McpToolTool) UnmarshalJSON(data []byte) error

func (McpToolTool) Validate ¶ 

func (v McpToolTool) Validate() error

type McpToolToolAnnotations ¶ 

type McpToolToolAnnotations struct {
	// If true, the tool may perform destructive updates.
	DestructiveHint *bool `json:"destructiveHint,omitempty"`
	// If true, calling the tool repeatedly with the same arguments
	// has no additional effect.
	IdempotentHint *bool `json:"idempotentHint,omitempty"`
	// If true, the tool interacts with the external world.
	OpenWorldHint *bool `json:"openWorldHint,omitempty"`
	// If true, the tool does not modify its environment.
	ReadOnlyHint *bool `json:"readOnlyHint,omitempty"`
	// A human-readable title for the tool.
	Title *string `json:"title,omitempty"`
}

Additional metadata about a tool to help clients decide how to display or control its use.

func (McpToolToolAnnotations) SchemaTitle ¶ 

func (McpToolToolAnnotations) SchemaTitle() string

func (McpToolToolAnnotations) Validate ¶ 

func (v McpToolToolAnnotations) Validate() error

type McpToolToolExecution ¶ 

type McpToolToolExecution struct {
	// Indicates the tool's preference for task-augmented execution.
	// Defaults to "forbidden" if not present.
	TaskSupport *McpToolTaskSupport `json:"taskSupport,omitempty"`
}

Execution-related properties for a tool.

func (McpToolToolExecution) SchemaTitle ¶ 

func (McpToolToolExecution) SchemaTitle() string

func (McpToolToolExecution) Validate ¶ 

func (v McpToolToolExecution) Validate() error

type McpToolToolResultContent ¶ 

type McpToolToolResultContent struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// Content blocks from the tool result.
	Content []McpToolContentBlock `json:"content" default:"[]"`
	// Whether this result represents an error.
	IsError *bool `json:"isError,omitempty"`
	// Structured content from the tool result.
	StructuredContent *OrderedMap[string, JsonValue] `json:"structuredContent,omitempty"`
	// The unique identifier for the corresponding tool call.
	ToolUseId string `json:"toolUseId"`
}

The result of a tool invocation.

func (McpToolToolResultContent) SchemaTitle ¶ 

func (McpToolToolResultContent) SchemaTitle() string

func (*McpToolToolResultContent) UnmarshalJSON ¶ 

func (v *McpToolToolResultContent) UnmarshalJSON(data []byte) error

func (McpToolToolResultContent) Validate ¶ 

func (v McpToolToolResultContent) Validate() error

type McpToolToolSchemaObject ¶ 

type McpToolToolSchemaObject struct {
	// Property definitions.
	Properties *OrderedMap[string, JsonValue] `json:"properties,omitempty"`
	// Required property names.
	Required *[]string `json:"required,omitempty"`
	// Always "object".
	Type McpToolToolSchemaType `json:"type"`
}

JSON Schema for tool input/output. Must have `type: "object"`.

func (McpToolToolSchemaObject) AdditionalProperties ¶ 

func (McpToolToolSchemaObject) AdditionalProperties() bool

func (McpToolToolSchemaObject) SchemaTitle ¶ 

func (McpToolToolSchemaObject) SchemaTitle() string

func (*McpToolToolSchemaObject) UnmarshalJSON ¶ 

func (v *McpToolToolSchemaObject) UnmarshalJSON(data []byte) error

func (McpToolToolSchemaObject) Validate ¶ 

func (v McpToolToolSchemaObject) Validate() error

type McpToolToolSchemaType ¶ 

type McpToolToolSchemaType struct {
	Object string `validate:"omitempty,oneof=object"`
}

The type of a JSON Schema used by MCP tools.

func (McpToolToolSchemaType) MarshalJSON ¶ 

func (v McpToolToolSchemaType) MarshalJSON() ([]byte, error)

func (McpToolToolSchemaType) SchemaTitle ¶ 

func (McpToolToolSchemaType) SchemaTitle() string

func (*McpToolToolSchemaType) UnmarshalJSON ¶ 

func (v *McpToolToolSchemaType) UnmarshalJSON(data []byte) error

func (McpToolToolSchemaType) Validate ¶ 

func (v McpToolToolSchemaType) Validate() error

type McpToolToolUseContent ¶ 

type McpToolToolUseContent struct {
	// Extension metadata.
	Meta *OrderedMap[string, JsonValue] `json:"_meta,omitempty"`
	// Unique identifier for this tool call.
	ID string `json:"id"`
	// Arguments to pass to the tool.
	Input OrderedMap[string, JsonValue] `json:"input"`
	// The name of the tool to invoke.
	Name string `json:"name"`
}

A tool call request from an assistant.

func (McpToolToolUseContent) SchemaTitle ¶ 

func (McpToolToolUseContent) SchemaTitle() string

func (*McpToolToolUseContent) UnmarshalJSON ¶ 

func (v *McpToolToolUseContent) UnmarshalJSON(data []byte) error

func (McpToolToolUseContent) Validate ¶ 

func (v McpToolToolUseContent) Validate() error

type McpToolsCapability ¶ 

type McpToolsCapability struct {
	// Whether the server emits notifications when the tool list changes.
	ListChanged *bool `json:"listChanged,omitempty"`
}

Capabilities for tools.

func (McpToolsCapability) SchemaTitle ¶ 

func (McpToolsCapability) SchemaTitle() string

func (McpToolsCapability) Validate ¶ 

func (v McpToolsCapability) Validate() error

type OrderedMap ¶ 

type OrderedMap[K comparable, V any] struct {
	// contains filtered or unexported fields
}

OrderedMap is a JSON-order-preserving map. It wraps orderedmap.OrderedMap in a value-type struct so that:

  • Value fields marshal correctly (no pointer-receiver issue)
  • *OrderedMap[K, V] expresses nullability naturally

func NewOrderedMap ¶ 

func NewOrderedMap[K comparable, V any](pairs ...orderedmap.Pair[K, V]) OrderedMap[K, V]

func (OrderedMap[K, V]) Delete ¶ 

func (om OrderedMap[K, V]) Delete(key K) (V, bool)

func (OrderedMap[K, V]) Get ¶ 

func (om OrderedMap[K, V]) Get(key K) (V, bool)

func (OrderedMap[K, V]) Len ¶ 

func (om OrderedMap[K, V]) Len() int

func (OrderedMap[K, V]) MarshalJSON ¶ 

func (om OrderedMap[K, V]) MarshalJSON() ([]byte, error)

func (OrderedMap[K, V]) Newest ¶ 

func (om OrderedMap[K, V]) Newest() *orderedmap.Pair[K, V]

func (OrderedMap[K, V]) Oldest ¶ 

func (om OrderedMap[K, V]) Oldest() *orderedmap.Pair[K, V]

func (OrderedMap[K, V]) Set ¶ 

func (om OrderedMap[K, V]) Set(key K, value V)

func (OrderedMap[K, V]) ToMapAny ¶ 

func (om OrderedMap[K, V]) ToMapAny() map[any]any

ToMapAny converts the OrderedMap to a map[any]any for validator dive support. This avoids reflection on unexported fields of the underlying ordered map.

func (*OrderedMap[K, V]) UnmarshalJSON ¶ 

func (om *OrderedMap[K, V]) UnmarshalJSON(data []byte) error

type PrefixedUuid ¶ 

type PrefixedUuid struct {
	UUID uuid.UUID `json:"uuid"`
}

A UUID with a 3-character prefix for type-safe identifiers.

This struct wraps a standard UUID and adds a compile-time prefix, ensuring that different types of identifiers (API keys, swarm IDs, etc.) cannot be confused at the type level.

The prefix is specified as three `const char` generic parameters.

Type Parameters ¶

* `PFX_1` - First character of the prefix * `PFX_2` - Second character of the prefix * `PFX_3` - Third character of the prefix

Examples ¶

``` use objectiveai::prefixed_uuid::PrefixedUuid;

// Define an API key type with prefix "apk" type ApiKey = PrefixedUuid<'a', 'p', 'k'>;

// Create a new API key let key = ApiKey::new(); println!("{}", key); // Outputs: apk<uuid> ```

func (PrefixedUuid) SchemaTitle ¶ 

func (PrefixedUuid) SchemaTitle() string

func (*PrefixedUuid) UnmarshalJSON ¶ 

func (v *PrefixedUuid) UnmarshalJSON(data []byte) error

func (PrefixedUuid) Validate ¶ 

func (v PrefixedUuid) Validate() error

type Remote ¶ 

type Remote struct {
	// GitHub repository.
	Github *RemoteGithub `validate:"omitempty,oneof=github"`
	// Local filesystem.
	Filesystem *RemoteFilesystem `validate:"omitempty,oneof=filesystem"`
	// Mock (for testing).
	Mock *RemoteMock `validate:"omitempty,oneof=mock"`
}

The remote source where a function, profile, or agent is hosted.

func (Remote) MarshalJSON ¶ 

func (v Remote) MarshalJSON() ([]byte, error)

func (Remote) SchemaTitle ¶ 

func (Remote) SchemaTitle() string

func (*Remote) UnmarshalJSON ¶ 

func (v *Remote) UnmarshalJSON(data []byte) error

func (Remote) Validate ¶ 

func (v Remote) Validate() error

type RemoteFilesystem ¶ 

type RemoteFilesystem string

func (RemoteFilesystem) SchemaVariantTitle ¶ 

func (RemoteFilesystem) SchemaVariantTitle() string

type RemoteGithub ¶ 

type RemoteGithub string

func (RemoteGithub) SchemaVariantTitle ¶ 

func (RemoteGithub) SchemaVariantTitle() string

type RemoteMock ¶ 

type RemoteMock string

func (RemoteMock) SchemaVariantTitle ¶ 

func (RemoteMock) SchemaVariantTitle() string

type RemotePath ¶ 

type RemotePath struct {
	Github     *RemotePathGithub
	Filesystem *RemotePathFilesystem
	Mock       *RemotePathMock
}

func (RemotePath) MarshalJSON ¶ 

func (v RemotePath) MarshalJSON() ([]byte, error)

func (RemotePath) SchemaTitle ¶ 

func (RemotePath) SchemaTitle() string

func (*RemotePath) UnmarshalJSON ¶ 

func (v *RemotePath) UnmarshalJSON(data []byte) error

func (RemotePath) Validate ¶ 

func (v RemotePath) Validate() error

type RemotePathCommitOptional ¶ 

type RemotePathCommitOptional struct {
	Github     *RemotePathCommitOptionalGithub
	Filesystem *RemotePathCommitOptionalFilesystem
	Mock       *RemotePathCommitOptionalMock
}

func (RemotePathCommitOptional) MarshalJSON ¶ 

func (v RemotePathCommitOptional) MarshalJSON() ([]byte, error)

func (RemotePathCommitOptional) SchemaTitle ¶ 

func (RemotePathCommitOptional) SchemaTitle() string

func (*RemotePathCommitOptional) UnmarshalJSON ¶ 

func (v *RemotePathCommitOptional) UnmarshalJSON(data []byte) error

func (RemotePathCommitOptional) Validate ¶ 

func (v RemotePathCommitOptional) Validate() error

type RemotePathCommitOptionalFilesystem ¶ 

type RemotePathCommitOptionalFilesystem struct {
	Commit     *string `json:"commit"`
	Owner      string  `json:"owner"`
	Remote     string  `json:"remote" validate:"oneof=filesystem"`
	Repository string  `json:"repository"`
}

func (RemotePathCommitOptionalFilesystem) SchemaVariantTitle ¶ 

func (RemotePathCommitOptionalFilesystem) SchemaVariantTitle() string

func (*RemotePathCommitOptionalFilesystem) UnmarshalJSON ¶ 

func (v *RemotePathCommitOptionalFilesystem) UnmarshalJSON(data []byte) error

type RemotePathCommitOptionalGithub ¶ 

type RemotePathCommitOptionalGithub struct {
	Commit     *string `json:"commit"`
	Owner      string  `json:"owner"`
	Remote     string  `json:"remote" validate:"oneof=github"`
	Repository string  `json:"repository"`
}

func (RemotePathCommitOptionalGithub) SchemaVariantTitle ¶ 

func (RemotePathCommitOptionalGithub) SchemaVariantTitle() string

func (*RemotePathCommitOptionalGithub) UnmarshalJSON ¶ 

func (v *RemotePathCommitOptionalGithub) UnmarshalJSON(data []byte) error

type RemotePathCommitOptionalMock ¶ 

type RemotePathCommitOptionalMock struct {
	Name   string `json:"name"`
	Remote string `json:"remote" validate:"oneof=mock"`
}

func (RemotePathCommitOptionalMock) SchemaVariantTitle ¶ 

func (RemotePathCommitOptionalMock) SchemaVariantTitle() string

func (*RemotePathCommitOptionalMock) UnmarshalJSON ¶ 

func (v *RemotePathCommitOptionalMock) UnmarshalJSON(data []byte) error

type RemotePathFilesystem ¶ 

type RemotePathFilesystem struct {
	Commit     string `json:"commit"`
	Owner      string `json:"owner"`
	Remote     string `json:"remote" validate:"oneof=filesystem"`
	Repository string `json:"repository"`
}

func (RemotePathFilesystem) SchemaVariantTitle ¶ 

func (RemotePathFilesystem) SchemaVariantTitle() string

func (*RemotePathFilesystem) UnmarshalJSON ¶ 

func (v *RemotePathFilesystem) UnmarshalJSON(data []byte) error

type RemotePathGithub ¶ 

type RemotePathGithub struct {
	Commit     string `json:"commit"`
	Owner      string `json:"owner"`
	Remote     string `json:"remote" validate:"oneof=github"`
	Repository string `json:"repository"`
}

func (RemotePathGithub) SchemaVariantTitle ¶ 

func (RemotePathGithub) SchemaVariantTitle() string

func (*RemotePathGithub) UnmarshalJSON ¶ 

func (v *RemotePathGithub) UnmarshalJSON(data []byte) error

type RemotePathMock ¶ 

type RemotePathMock struct {
	Name   string `json:"name"`
	Remote string `json:"remote" validate:"oneof=mock"`
}

func (RemotePathMock) SchemaVariantTitle ¶ 

func (RemotePathMock) SchemaVariantTitle() string

func (*RemotePathMock) UnmarshalJSON ¶ 

func (v *RemotePathMock) UnmarshalJSON(data []byte) error

type SchemaBody ¶ 

type SchemaBody interface {
	Body() map[string]any
}

SchemaBody provides the non-title/non-description parts of a schema for types where the structure cannot be inferred from Go reflection (anyOf interfaces, enums, arrays, primitives).

Struct types do NOT implement this — their properties are derived from reflection on struct fields + tags by the roundtrip test.

type Stream ¶ 

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

Stream is a typed SSE event stream from the API. Call Next() to read events, Close() when done. The context passed to PostStreaming controls cancellation.

func AgentCompletionsCreateAgentCompletionStreaming ¶ 

func AgentCompletionsCreateAgentCompletionStreaming(ctx context.Context, c *Client, params AgentCompletionsRequestAgentCompletionCreateParams) (*Stream[AgentCompletionsResponseStreamingAgentCompletionChunk], error)

func ErrorCreateErrorStreaming ¶ 

func ErrorCreateErrorStreaming(ctx context.Context, c *Client, params ErrorErrorCreateParams) (*Stream[ErrorErrorResponse], error)

func FunctionsExecutionsCreateFunctionExecutionStreaming ¶ 

func FunctionsExecutionsCreateFunctionExecutionStreaming(ctx context.Context, c *Client, params FunctionsExecutionsRequestFunctionExecutionCreateParams) (*Stream[FunctionsExecutionsResponseStreamingFunctionExecutionChunk], error)

func FunctionsInventionsCreateFunctionInventionStreaming ¶ 

func FunctionsInventionsCreateFunctionInventionStreaming(ctx context.Context, c *Client, params FunctionsInventionsRequestFunctionInventionCreateParams) (*Stream[FunctionsInventionsResponseStreamingFunctionInventionChunk], error)

func FunctionsInventionsRecursiveCreateFunctionInventionRecursiveStreaming ¶ 

func FunctionsInventionsRecursiveCreateFunctionInventionRecursiveStreaming(ctx context.Context, c *Client, params FunctionsInventionsRecursiveRequestFunctionInventionRecursiveCreateParams) (*Stream[FunctionsInventionsRecursiveResponseStreamingFunctionInventionRecursiveChunk], error)

func FunctionsProfilesComputationsComputeProfileStreaming ¶ 

func FunctionsProfilesComputationsComputeProfileStreaming(ctx context.Context, c *Client, params FunctionsProfilesComputationsRequestFunctionProfileComputationCreateParams) (*Stream[FunctionsProfilesComputationsResponseStreamingFunctionProfileComputationChunk], error)

func LaboratoriesExecutionsCreateLaboratoryExecutionStreaming ¶ 

func LaboratoriesExecutionsCreateLaboratoryExecutionStreaming(ctx context.Context, c *Client, params LaboratoriesExecutionsRequestLaboratoryExecutionCreateParams) (*Stream[LaboratoriesExecutionsResponseStreamingLaboratoryExecutionChunk], error)

func PostStreaming ¶ 

func PostStreaming[T any](ctx context.Context, c *Client, path string, body any) (*Stream[T], error)

PostStreaming sends a POST request and returns a typed SSE event stream.

func VectorCompletionsCreateVectorCompletionStreaming ¶ 

func VectorCompletionsCreateVectorCompletionStreaming(ctx context.Context, c *Client, params VectorCompletionsRequestVectorCompletionCreateParams) (*Stream[VectorCompletionsResponseStreamingVectorCompletionChunk], error)

func (*Stream[T]) Close ¶ 

func (s *Stream[T]) Close() error

Close closes the underlying response body.

func (*Stream[T]) Next ¶ 

func (s *Stream[T]) Next() (*T, error)

Next reads the next event from the stream. Returns the parsed event, or an error. Returns io.EOF when complete.

type SwarmGetSwarmResponse ¶ 

type SwarmGetSwarmResponse struct {
	RemotePath
}

Response containing a single Swarm.

func SwarmGetSwarm ¶ 

func SwarmGetSwarm(ctx context.Context, c *Client, params RemotePathCommitOptional) (*SwarmGetSwarmResponse, error)

func (SwarmGetSwarmResponse) SchemaTitle ¶ 

func (SwarmGetSwarmResponse) SchemaTitle() string

func (SwarmGetSwarmResponse) Validate ¶ 

func (v SwarmGetSwarmResponse) Validate() error

type SwarmInlineSwarm ¶ 

type SwarmInlineSwarm struct {
	// The validated and deduplicated LLMs, sorted by full_id.
	Agents []AgentAgentWithFallbacksWithCount `json:"agents"`
	// The deterministic content-addressed ID (22-character base62 string).
	ID string `json:"id"`
	// The aligned weights for each agent.
	Weights Weights `json:"weights"`
}

A validated inline Swarm with its computed content-addressed ID.

Created by converting from [`InlineSwarmBase`] via [`InlineSwarmBase::convert`]. The conversion: 1. Validates and normalizes each agent 2. Merges duplicate LLMs (by full_id) and sums their counts 3. Sorts LLMs by full_id for deterministic ordering 4. Computes the swarm ID from the sorted (full_id, count) pairs 5. Aligns weights (merging duplicates by weighted average)

Constraints ¶

- Individual LLMs with `count: 0` are skipped - Total agent count (sum of all counts) must be between 1 and 128

func (SwarmInlineSwarm) SchemaTitle ¶ 

func (SwarmInlineSwarm) SchemaTitle() string

func (*SwarmInlineSwarm) UnmarshalJSON ¶ 

func (v *SwarmInlineSwarm) UnmarshalJSON(data []byte) error

func (SwarmInlineSwarm) Validate ¶ 

func (v SwarmInlineSwarm) Validate() error

type SwarmInlineSwarmBase ¶ 

type SwarmInlineSwarmBase struct {
	// The LLMs in this swarm, with optional counts and fallbacks.
	Agents []AgentInlineAgentBaseWithFallbacksOrRemoteWithCount `json:"agents"`
	// Optional weights for each agent. If `None`, uniform weights are used.
	Weights *Weights `json:"weights,omitempty"`
}

An inline swarm base definition (without computed ID or metadata).

Contains a list of agent configurations that will be validated, deduplicated, and sorted when converting to an [`InlineSwarm`].

func (SwarmInlineSwarmBase) SchemaTitle ¶ 

func (SwarmInlineSwarmBase) SchemaTitle() string

func (*SwarmInlineSwarmBase) UnmarshalJSON ¶ 

func (v *SwarmInlineSwarmBase) UnmarshalJSON(data []byte) error

func (SwarmInlineSwarmBase) Validate ¶ 

func (v SwarmInlineSwarmBase) Validate() error

type SwarmInlineSwarmBaseOrRemote ¶ 

type SwarmInlineSwarmBaseOrRemote struct {
	SwarmBase *SwarmInlineSwarmBase
	Remote    *RemotePath
}

A swarm specification that is either an inline swarm base or a remote path reference.

func (SwarmInlineSwarmBaseOrRemote) MarshalJSON ¶ 

func (v SwarmInlineSwarmBaseOrRemote) MarshalJSON() ([]byte, error)

func (SwarmInlineSwarmBaseOrRemote) SchemaTitle ¶ 

func (SwarmInlineSwarmBaseOrRemote) SchemaTitle() string

func (*SwarmInlineSwarmBaseOrRemote) UnmarshalJSON ¶ 

func (v *SwarmInlineSwarmBaseOrRemote) UnmarshalJSON(data []byte) error

func (SwarmInlineSwarmBaseOrRemote) Validate ¶ 

func (v SwarmInlineSwarmBaseOrRemote) Validate() error

type SwarmInlineSwarmBaseOrRemoteCommitOptional ¶ 

type SwarmInlineSwarmBaseOrRemoteCommitOptional struct {
	SwarmBase *SwarmInlineSwarmBase
	Remote    *RemotePathCommitOptional
}

Like [`InlineSwarmBaseOrRemote`] but with optional commit. Used in request types where commit resolution happens server-side.

func (SwarmInlineSwarmBaseOrRemoteCommitOptional) MarshalJSON ¶ 

func (v SwarmInlineSwarmBaseOrRemoteCommitOptional) MarshalJSON() ([]byte, error)

func (SwarmInlineSwarmBaseOrRemoteCommitOptional) SchemaTitle ¶ 

func (SwarmInlineSwarmBaseOrRemoteCommitOptional) SchemaTitle() string

func (*SwarmInlineSwarmBaseOrRemoteCommitOptional) UnmarshalJSON ¶ 

func (v *SwarmInlineSwarmBaseOrRemoteCommitOptional) UnmarshalJSON(data []byte) error

func (SwarmInlineSwarmBaseOrRemoteCommitOptional) Validate ¶ 

func (v SwarmInlineSwarmBaseOrRemoteCommitOptional) Validate() error

type SwarmListSwarmResponse ¶ 

type SwarmListSwarmResponse struct {
	// The list of Swarm summaries.
	Data []RemotePath `json:"data"`
}

Response containing a list of Swarms.

func SwarmListSwarms ¶ 

func SwarmListSwarms(ctx context.Context, c *Client, params SwarmListSwarmsRequest) (*SwarmListSwarmResponse, error)

func (SwarmListSwarmResponse) SchemaTitle ¶ 

func (SwarmListSwarmResponse) SchemaTitle() string

func (*SwarmListSwarmResponse) UnmarshalJSON ¶ 

func (v *SwarmListSwarmResponse) UnmarshalJSON(data []byte) error

func (SwarmListSwarmResponse) Validate ¶ 

func (v SwarmListSwarmResponse) Validate() error

type SwarmListSwarmsRequest ¶ 

type SwarmListSwarmsRequest struct {
	// Optional source filter for listing swarms.
	Source *SwarmListSwarmsSource `json:"source,omitempty"`
}

Query parameters for the list swarms endpoint.

func (SwarmListSwarmsRequest) SchemaTitle ¶ 

func (SwarmListSwarmsRequest) SchemaTitle() string

func (SwarmListSwarmsRequest) Validate ¶ 

func (v SwarmListSwarmsRequest) Validate() error

type SwarmListSwarmsSource ¶ 

type SwarmListSwarmsSource struct {
	All         *string `validate:"omitempty,oneof=all"`
	Mock        *string `validate:"omitempty,oneof=mock"`
	Filesystem  *string `validate:"omitempty,oneof=filesystem"`
	Objectiveai *string `validate:"omitempty,oneof=objectiveai"`
}

Source filter for listing swarms.

func (SwarmListSwarmsSource) MarshalJSON ¶ 

func (v SwarmListSwarmsSource) MarshalJSON() ([]byte, error)

func (SwarmListSwarmsSource) SchemaTitle ¶ 

func (SwarmListSwarmsSource) SchemaTitle() string

func (*SwarmListSwarmsSource) UnmarshalJSON ¶ 

func (v *SwarmListSwarmsSource) UnmarshalJSON(data []byte) error

func (SwarmListSwarmsSource) Validate ¶ 

func (v SwarmListSwarmsSource) Validate() error

type SwarmRemoteSwarm ¶ 

type SwarmRemoteSwarm struct {
	SwarmInlineSwarm
	Description string `json:"description"`
}

A validated remote Swarm with metadata and computed content-addressed ID.

func (SwarmRemoteSwarm) MarshalJSON ¶ 

func (v SwarmRemoteSwarm) MarshalJSON() ([]byte, error)

func (SwarmRemoteSwarm) SchemaTitle ¶ 

func (SwarmRemoteSwarm) SchemaTitle() string

func (*SwarmRemoteSwarm) UnmarshalJSON ¶ 

func (v *SwarmRemoteSwarm) UnmarshalJSON(data []byte) error

func (SwarmRemoteSwarm) Validate ¶ 

func (v SwarmRemoteSwarm) Validate() error

type SwarmRemoteSwarmBase ¶ 

type SwarmRemoteSwarmBase struct {
	SwarmInlineSwarmBase
	// Human-readable description of what this swarm does.
	Description string `json:"description"`
}

A remote swarm base definition with metadata (without computed ID).

Like [`InlineSwarmBase`] but includes a description for remote storage.

func (SwarmRemoteSwarmBase) MarshalJSON ¶ 

func (v SwarmRemoteSwarmBase) MarshalJSON() ([]byte, error)

func (SwarmRemoteSwarmBase) SchemaTitle ¶ 

func (SwarmRemoteSwarmBase) SchemaTitle() string

func (*SwarmRemoteSwarmBase) UnmarshalJSON ¶ 

func (v *SwarmRemoteSwarmBase) UnmarshalJSON(data []byte) error

func (SwarmRemoteSwarmBase) Validate ¶ 

func (v SwarmRemoteSwarmBase) Validate() error

type SwarmSwarm ¶ 

type SwarmSwarm struct {
	Remote *SwarmRemoteSwarm
	Inline *SwarmInlineSwarm
}

A validated Swarm, either remote (with metadata) or inline.

func ValidateSwarm ¶ 

func ValidateSwarm(swarm SwarmSwarmBase, remoteAgents map[string]AgentRemoteAgentBaseWithFallbacks) (*SwarmSwarm, error)

ValidateSwarm validates a Swarm configuration and computes its content-addressed ID. Pass nil for remoteAgents if no remote agent definitions are available.

func (SwarmSwarm) MarshalJSON ¶ 

func (v SwarmSwarm) MarshalJSON() ([]byte, error)

func (SwarmSwarm) SchemaTitle ¶ 

func (SwarmSwarm) SchemaTitle() string

func (*SwarmSwarm) UnmarshalJSON ¶ 

func (v *SwarmSwarm) UnmarshalJSON(data []byte) error

func (SwarmSwarm) Validate ¶ 

func (v SwarmSwarm) Validate() error

type SwarmSwarmBase ¶ 

type SwarmSwarmBase struct {
	Remote *SwarmRemoteSwarmBase
	Inline *SwarmInlineSwarmBase
}

A swarm base definition, either remote (with metadata) or inline.

func (SwarmSwarmBase) MarshalJSON ¶ 

func (v SwarmSwarmBase) MarshalJSON() ([]byte, error)

func (SwarmSwarmBase) SchemaTitle ¶ 

func (SwarmSwarmBase) SchemaTitle() string

func (*SwarmSwarmBase) UnmarshalJSON ¶ 

func (v *SwarmSwarmBase) UnmarshalJSON(data []byte) error

func (SwarmSwarmBase) Validate ¶ 

func (v SwarmSwarmBase) Validate() error

type SwarmUsageSwarmResponse ¶ 

type SwarmUsageSwarmResponse struct {
	// Total completion tokens generated across all agents.
	CompletionTokens uint64 `json:"completion_tokens" validate:"min=0,max=18446744073709551615"`
	// Total prompt tokens processed across all agents.
	PromptTokens uint64 `json:"prompt_tokens" validate:"min=0,max=18446744073709551615"`
	// Total number of requests made with this Swarm.
	Requests uint64 `json:"requests" validate:"min=0,max=18446744073709551615"`
	// Total cost incurred.
	TotalCost float64 `json:"total_cost" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

Usage statistics for a Swarm.

func SwarmGetSwarmUsage ¶ 

func SwarmGetSwarmUsage(ctx context.Context, c *Client, params RemotePathCommitOptional) (*SwarmUsageSwarmResponse, error)

func (SwarmUsageSwarmResponse) SchemaTitle ¶ 

func (SwarmUsageSwarmResponse) SchemaTitle() string

func (*SwarmUsageSwarmResponse) UnmarshalJSON ¶ 

func (v *SwarmUsageSwarmResponse) UnmarshalJSON(data []byte) error

func (SwarmUsageSwarmResponse) Validate ¶ 

func (v SwarmUsageSwarmResponse) Validate() error

type VectorCompletionsCacheCacheVote ¶ 

type VectorCompletionsCacheCacheVote struct {
	Vote *VectorCompletionsResponseVote `json:"vote"`
}

func VectorCompletionsCacheGetCacheVote ¶ 

func VectorCompletionsCacheGetCacheVote(ctx context.Context, c *Client, params VectorCompletionsCacheCacheVoteRequest) (*VectorCompletionsCacheCacheVote, error)

func (VectorCompletionsCacheCacheVote) SchemaTitle ¶ 

func (VectorCompletionsCacheCacheVote) SchemaTitle() string

func (VectorCompletionsCacheCacheVote) Validate ¶ 

func (v VectorCompletionsCacheCacheVote) Validate() error

type VectorCompletionsCacheCacheVoteRequest ¶ 

type VectorCompletionsCacheCacheVoteRequest struct {
	Agent     AgentInlineAgentBaseWithFallbacksOrRemote `json:"agent"`
	Messages  []AgentCompletionsMessageMessage          `json:"messages"`
	Responses []AgentCompletionsMessageRichContent      `json:"responses"`
}

func (VectorCompletionsCacheCacheVoteRequest) SchemaTitle ¶ 

func (VectorCompletionsCacheCacheVoteRequest) SchemaTitle() string

func (*VectorCompletionsCacheCacheVoteRequest) UnmarshalJSON ¶ 

func (v *VectorCompletionsCacheCacheVoteRequest) UnmarshalJSON(data []byte) error

func (VectorCompletionsCacheCacheVoteRequest) Validate ¶ 

func (v VectorCompletionsCacheCacheVoteRequest) Validate() error

type VectorCompletionsCacheCompletionVotes ¶ 

type VectorCompletionsCacheCompletionVotes struct {
	Data *[]VectorCompletionsResponseVote `json:"data"`
}

func VectorCompletionsCacheGetCompletionVotes ¶ 

func VectorCompletionsCacheGetCompletionVotes(ctx context.Context, c *Client, params VectorCompletionsCacheGetCompletionVotesRequest) (*VectorCompletionsCacheCompletionVotes, error)

func (VectorCompletionsCacheCompletionVotes) SchemaTitle ¶ 

func (VectorCompletionsCacheCompletionVotes) SchemaTitle() string

func (VectorCompletionsCacheCompletionVotes) Validate ¶ 

func (v VectorCompletionsCacheCompletionVotes) Validate() error

type VectorCompletionsCacheGetCompletionVotesRequest ¶ 

type VectorCompletionsCacheGetCompletionVotesRequest struct {
	// The vector completion ID.
	ID string `json:"id"`
}

Request body for retrieving completion votes by vector completion ID.

func (VectorCompletionsCacheGetCompletionVotesRequest) SchemaTitle ¶ 

func (VectorCompletionsCacheGetCompletionVotesRequest) SchemaTitle() string

func (*VectorCompletionsCacheGetCompletionVotesRequest) UnmarshalJSON ¶ 

func (v *VectorCompletionsCacheGetCompletionVotesRequest) UnmarshalJSON(data []byte) error

func (VectorCompletionsCacheGetCompletionVotesRequest) Validate ¶ 

func (v VectorCompletionsCacheGetCompletionVotesRequest) Validate() error

type VectorCompletionsRequestVectorCompletionCreateParams ¶ 

type VectorCompletionsRequestVectorCompletionCreateParams struct {
	// Continuation from a previous completion, as a base64-encoded string.
	Continuation *string `json:"continuation,omitempty"`
	// If true, uses cached votes when available.
	FromCache *bool `json:"from_cache,omitempty"`
	// The conversation messages (the prompt).
	Messages []AgentCompletionsMessageMessage `json:"messages"`
	// Provider routing preferences.
	Provider *AgentCompletionsRequestProvider `json:"provider,omitempty"`
	// The possible responses the LLMs can vote for.
	Responses []AgentCompletionsMessageRichContent `json:"responses"`
	// If present, reuses votes from a previous request with this ID.
	Retry *string `json:"retry,omitempty"`
	// Random seed for deterministic results.
	Seed *int64 `json:"seed,omitempty" validate:"omitempty,min=-9223372036854775808,max=9223372036854775807"`
	// Whether to stream the response.
	Stream *bool `json:"stream,omitempty"`
	// The Swarm of agents to use.
	Swarm SwarmInlineSwarmBaseOrRemoteCommitOptional `json:"swarm"`
}

Parameters for creating a vector completion.

Vector completions run multiple agent completions (one per LLM in the swarm), force each to vote for one of the predefined responses, and combine votes using the provided profile weights to produce final scores.

func (VectorCompletionsRequestVectorCompletionCreateParams) SchemaTitle ¶ 

func (VectorCompletionsRequestVectorCompletionCreateParams) SchemaTitle() string

func (*VectorCompletionsRequestVectorCompletionCreateParams) UnmarshalJSON ¶ 

func (v *VectorCompletionsRequestVectorCompletionCreateParams) UnmarshalJSON(data []byte) error

func (VectorCompletionsRequestVectorCompletionCreateParams) Validate ¶ 

func (v VectorCompletionsRequestVectorCompletionCreateParams) Validate() error

type VectorCompletionsResponseStreamingAgentCompletionChunk ¶ 

type VectorCompletionsResponseStreamingAgentCompletionChunk struct {
	// Continuation state for multi-turn conversations (only present in the final chunk).
	Continuation *string `json:"continuation,omitempty"`
	Created      uint64  `json:"created" validate:"min=0,max=18446744073709551615"`
	// Error details if this completion failed.
	Error *ErrorResponseError `json:"error,omitempty"`
	ID    string              `json:"id"`
	// Index used to correlate chunks from the same completion.
	Index    uint64                                          `json:"index" validate:"min=0,max=18446744073709551615"`
	Messages []AgentCompletionsResponseStreamingMessageChunk `json:"messages"`
	// The object type (always "agent.completion.chunk").
	Object AgentCompletionsResponseStreamingObject `json:"object"`
	// Upstream provider
	Upstream AgentUpstream `json:"upstream"`
	// Token usage (only present in the final chunk).
	Usage *AgentCompletionsResponseUsage `json:"usage,omitempty"`
}

A streaming agent completion chunk from a single agent within a vector completion.

The `index` field is used to correlate chunks belonging to the same underlying completion when accumulating via [`push`](Self::push).

func (*VectorCompletionsResponseStreamingAgentCompletionChunk) Push ¶ 

func (v *VectorCompletionsResponseStreamingAgentCompletionChunk) Push(other *VectorCompletionsResponseStreamingAgentCompletionChunk)

Push accumulates another vector completions AgentCompletionChunk into this one.

func (VectorCompletionsResponseStreamingAgentCompletionChunk) SchemaTitle ¶ 

func (VectorCompletionsResponseStreamingAgentCompletionChunk) SchemaTitle() string

func (*VectorCompletionsResponseStreamingAgentCompletionChunk) UnmarshalJSON ¶ 

func (v *VectorCompletionsResponseStreamingAgentCompletionChunk) UnmarshalJSON(data []byte) error

func (VectorCompletionsResponseStreamingAgentCompletionChunk) Validate ¶ 

func (v VectorCompletionsResponseStreamingAgentCompletionChunk) Validate() error

type VectorCompletionsResponseStreamingObject ¶ 

type VectorCompletionsResponseStreamingObject struct {
	VectorCompletionChunk string `validate:"omitempty,oneof=vector.completion.chunk"`
}

A streaming vector completion chunk.

func (VectorCompletionsResponseStreamingObject) MarshalJSON ¶ 

func (v VectorCompletionsResponseStreamingObject) MarshalJSON() ([]byte, error)

func (VectorCompletionsResponseStreamingObject) SchemaTitle ¶ 

func (VectorCompletionsResponseStreamingObject) SchemaTitle() string

func (*VectorCompletionsResponseStreamingObject) UnmarshalJSON ¶ 

func (v *VectorCompletionsResponseStreamingObject) UnmarshalJSON(data []byte) error

func (VectorCompletionsResponseStreamingObject) Validate ¶ 

func (v VectorCompletionsResponseStreamingObject) Validate() error

type VectorCompletionsResponseStreamingVectorCompletionChunk ¶ 

type VectorCompletionsResponseStreamingVectorCompletionChunk struct {
	// Incremental agent completion chunks from each agent.
	Completions []VectorCompletionsResponseStreamingAgentCompletionChunk `json:"completions"`
	// Unix timestamp when the completion was created.
	Created uint64 `json:"created" validate:"min=0,max=18446744073709551615"`
	// Unique identifier for this vector completion.
	ID string `json:"id"`
	// Object type identifier (`"vector.completion.chunk"`).
	Object VectorCompletionsResponseStreamingObject `json:"object"`
	// Current weighted scores. Updated as new votes arrive.
	Scores []float64 `json:"scores" validate:"dive,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// ID of the swarm used for this completion.
	Swarm string `json:"swarm"`
	// Aggregated usage statistics. Typically present only in the final chunk.
	Usage *AgentCompletionsResponseUsage `json:"usage,omitempty"`
	// Votes received so far. New votes are appended in subsequent chunks.
	Votes []VectorCompletionsResponseVote `json:"votes"`
	// Current weight distribution across responses. Updated as new votes arrive.
	Weights []float64 `json:"weights" validate:"dive,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

A chunk in a streaming vector completion response.

Each chunk contains incremental updates to the completion. Use the [`push`](Self::push) method to accumulate chunks into a complete response.

func GenerateVectorCompletionChunk ¶ 

func GenerateVectorCompletionChunk(hasSeed bool, seed int64) (*VectorCompletionsResponseStreamingVectorCompletionChunk, error)

GenerateVectorCompletionChunk generates a random VectorCompletionChunk from a seed.

func VectorCompletionChunkMerged ¶ 

func VectorCompletionChunkMerged(a, b VectorCompletionsResponseStreamingVectorCompletionChunk) (*VectorCompletionsResponseStreamingVectorCompletionChunk, error)

VectorCompletionChunkMerged merges two VectorCompletionChunks via push.

func VectorCompletionChunkNormalized ¶ 

func VectorCompletionChunkNormalized(chunk VectorCompletionsResponseStreamingVectorCompletionChunk) (*VectorCompletionsResponseStreamingVectorCompletionChunk, error)

VectorCompletionChunkNormalized normalizes a VectorCompletionChunk.

func (*VectorCompletionsResponseStreamingVectorCompletionChunk) Push ¶ 

func (v *VectorCompletionsResponseStreamingVectorCompletionChunk) Push(other *VectorCompletionsResponseStreamingVectorCompletionChunk)

Push accumulates another VectorCompletionChunk into this one.

func (VectorCompletionsResponseStreamingVectorCompletionChunk) SchemaTitle ¶ 

func (VectorCompletionsResponseStreamingVectorCompletionChunk) SchemaTitle() string

func (*VectorCompletionsResponseStreamingVectorCompletionChunk) UnmarshalJSON ¶ 

func (v *VectorCompletionsResponseStreamingVectorCompletionChunk) UnmarshalJSON(data []byte) error

func (VectorCompletionsResponseStreamingVectorCompletionChunk) Validate ¶ 

func (v VectorCompletionsResponseStreamingVectorCompletionChunk) Validate() error

type VectorCompletionsResponseUnaryAgentCompletion ¶ 

type VectorCompletionsResponseUnaryAgentCompletion struct {
	// Continuation state for multi-turn conversations.
	Continuation *string `json:"continuation"`
	Created      uint64  `json:"created" validate:"min=0,max=18446744073709551615"`
	// Error details if this completion failed.
	Error *ErrorResponseError `json:"error"`
	ID    string              `json:"id"`
	// Index of this completion within the vector completion.
	Index    uint64                                 `json:"index" validate:"min=0,max=18446744073709551615"`
	Messages []AgentCompletionsResponseUnaryMessage `json:"messages"`
	// The object type (always "agent.completion").
	Object AgentCompletionsResponseUnaryObject `json:"object"`
	// Upstream provider
	Upstream AgentUpstream                 `json:"upstream"`
	Usage    AgentCompletionsResponseUsage `json:"usage"`
}

A agent completion from a single agent within a vector completion.

Wraps the standard agent completion response with an index to identify which agent in the swarm produced it.

func (VectorCompletionsResponseUnaryAgentCompletion) SchemaTitle ¶ 

func (VectorCompletionsResponseUnaryAgentCompletion) SchemaTitle() string

func (*VectorCompletionsResponseUnaryAgentCompletion) UnmarshalJSON ¶ 

func (v *VectorCompletionsResponseUnaryAgentCompletion) UnmarshalJSON(data []byte) error

func (VectorCompletionsResponseUnaryAgentCompletion) Validate ¶ 

func (v VectorCompletionsResponseUnaryAgentCompletion) Validate() error

type VectorCompletionsResponseUnaryObject ¶ 

type VectorCompletionsResponseUnaryObject struct {
	VectorCompletion string `validate:"omitempty,oneof=vector.completion"`
}

A complete vector completion response.

func (VectorCompletionsResponseUnaryObject) MarshalJSON ¶ 

func (v VectorCompletionsResponseUnaryObject) MarshalJSON() ([]byte, error)

func (VectorCompletionsResponseUnaryObject) SchemaTitle ¶ 

func (VectorCompletionsResponseUnaryObject) SchemaTitle() string

func (*VectorCompletionsResponseUnaryObject) UnmarshalJSON ¶ 

func (v *VectorCompletionsResponseUnaryObject) UnmarshalJSON(data []byte) error

func (VectorCompletionsResponseUnaryObject) Validate ¶ 

func (v VectorCompletionsResponseUnaryObject) Validate() error

type VectorCompletionsResponseUnaryVectorCompletion ¶ 

type VectorCompletionsResponseUnaryVectorCompletion struct {
	// The underlying agent completions from each agent in the swarm.
	Completions []VectorCompletionsResponseUnaryAgentCompletion `json:"completions"`
	// Unix timestamp when the completion was created.
	Created uint64 `json:"created" validate:"min=0,max=18446744073709551615"`
	// Unique identifier for this vector completion.
	ID string `json:"id"`
	// Object type identifier (`"vector.completion"`).
	Object VectorCompletionsResponseUnaryObject `json:"object"`
	// Final weighted scores for each response option. Sums to 1.
	Scores []float64 `json:"scores" validate:"dive,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// ID of the swarm used for this completion.
	Swarm string `json:"swarm"`
	// Aggregated token and cost usage across all completions.
	Usage AgentCompletionsResponseUsage `json:"usage"`
	// Individual votes from each agent, showing their selections.
	Votes []VectorCompletionsResponseVote `json:"votes"`
	// Total weight allocated to each response option. Same length as `scores`.
	// For discrete votes, an LLM's full weight goes to its selected response.
	// For probabilistic votes, the weight is divided according to the distribution.
	Weights []float64 `json:"weights" validate:"dive,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

A complete vector completion response (non-streaming).

Contains the final scores, all votes from the swarm, and the underlying agent completions that produced those votes.

func NormalizeVectorCompletionForTests ¶ 

func NormalizeVectorCompletionForTests(v VectorCompletionsResponseUnaryVectorCompletion) (*VectorCompletionsResponseUnaryVectorCompletion, error)

NormalizeVectorCompletionForTests normalizes a VectorCompletion by round-tripping through serde.

func VectorCompletionChunkToUnary ¶ 

func VectorCompletionChunkToUnary(chunk VectorCompletionsResponseStreamingVectorCompletionChunk) (*VectorCompletionsResponseUnaryVectorCompletion, error)

VectorCompletionChunkToUnary converts an accumulated chunk to a unary VectorCompletion.

func VectorCompletionsCreateVectorCompletionUnary ¶ 

func VectorCompletionsCreateVectorCompletionUnary(ctx context.Context, c *Client, params VectorCompletionsRequestVectorCompletionCreateParams) (*VectorCompletionsResponseUnaryVectorCompletion, error)

func (VectorCompletionsResponseUnaryVectorCompletion) SchemaTitle ¶ 

func (VectorCompletionsResponseUnaryVectorCompletion) SchemaTitle() string

func (*VectorCompletionsResponseUnaryVectorCompletion) UnmarshalJSON ¶ 

func (v *VectorCompletionsResponseUnaryVectorCompletion) UnmarshalJSON(data []byte) error

func (VectorCompletionsResponseUnaryVectorCompletion) Validate ¶ 

func (v VectorCompletionsResponseUnaryVectorCompletion) Validate() error

type VectorCompletionsResponseVote ¶ 

type VectorCompletionsResponseVote struct {
	// The agent that produced this vote (content-addressed ID).
	Agent string `json:"agent"`
	// Flattened index accounting for agent counts in the swarm.
	FlatSwarmIndex uint64 `json:"flat_swarm_index" validate:"min=0,max=18446744073709551615"`
	// If true, this vote was retrieved from cache rather than generated fresh.
	FromCache *bool `json:"from_cache,omitempty"`
	// Content hash of the request messages (for caching/deduplication).
	PromptID string `json:"prompt_id"`
	// Content hashes of each response option in the request.
	ResponsesIds []string `json:"responses_ids"`
	// If true, this vote was reused from a previous request via the `retry`
	// parameter. All fields reflect the original request's values.
	Retry *bool `json:"retry,omitempty"`
	// Index of the agent configuration within the swarm.
	SwarmIndex uint64 `json:"swarm_index" validate:"min=0,max=18446744073709551615"`
	// The vote distribution. Each index corresponds to a response from the
	// request. Typically one element is 1.0 (selected) and the rest are 0.0.
	Vote []float64 `json:"vote" validate:"dive,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// The weight applied to this vote when computing final scores.
	Weight float64 `json:"weight" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

A single LLM's vote in a vector completion.

Each LLM in the swarm produces a vote indicating which response(s) it selected. Votes are weighted according to the profile and combined to produce the final scores.

Vote Format ¶

The `vote` field is a vector of decimals corresponding to the responses in the request. Typically one element is 1.0 and the rest are 0.0 (discrete selection), but when `top_logprobs` is used, votes may be probability distributions.

func (VectorCompletionsResponseVote) SchemaTitle ¶ 

func (VectorCompletionsResponseVote) SchemaTitle() string

func (*VectorCompletionsResponseVote) UnmarshalJSON ¶ 

func (v *VectorCompletionsResponseVote) UnmarshalJSON(data []byte) error

func (VectorCompletionsResponseVote) Validate ¶ 

func (v VectorCompletionsResponseVote) Validate() error

type VectorCompletionsVectorResponses ¶ 

type VectorCompletionsVectorResponses []AgentCompletionsMessageRichContent

The list of response options in a vector completion request.

Each element is a [`RichContent`] value that an LLM can vote for. Responses can be plain text strings or multi-part content containing text, images, audio, video, or files.

Minimum Length ¶

A vector completion requires at least 2 responses to vote between.

Examples ¶

Plain text responses: ```json ["Yes", "No", "Maybe"] ```

Multimodal responses: ```json [ 

[{"type": "text", "text": "Option A"}, {"type": "image_url", "image_url": {"url": "https://example.com/a.png"}}],
[{"type": "text", "text": "Option B"}, {"type": "image_url", "image_url": {"url": "https://example.com/b.png"}}]

] ```

func (VectorCompletionsVectorResponses) SchemaTitle ¶ 

func (VectorCompletionsVectorResponses) SchemaTitle() string

type Weights ¶ 

type Weights struct {
	// Simple vector of decimal weights.
	Weights *WeightsWeights `validate:"omitempty,dive,min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
	// Vector of entries with optional invert flags.
	Entries *WeightsEntries
}

Weights for a swarm's agents.

- `Weights(Vec<Decimal>)` - simple representation (no inversion) - `Entries(Vec<WeightsEntry>)` - weights with optional per-agent `invert`

func (Weights) MarshalJSON ¶ 

func (v Weights) MarshalJSON() ([]byte, error)

func (Weights) SchemaTitle ¶ 

func (Weights) SchemaTitle() string

func (*Weights) UnmarshalJSON ¶ 

func (v *Weights) UnmarshalJSON(data []byte) error

func (Weights) Validate ¶ 

func (v Weights) Validate() error

type WeightsEntries ¶ 

type WeightsEntries []WeightsEntry

func (WeightsEntries) SchemaVariantTitle ¶ 

func (WeightsEntries) SchemaVariantTitle() string

type WeightsEntry ¶ 

type WeightsEntry struct {
	// If true, invert this agent's vote distribution before combining.
	//
	// When omitted or false, the vote distribution is used as-is.
	Invert *bool `json:"invert,omitempty"`
	// The weight for this agent in the swarm. Must be in [0, 1].
	Weight float64 `json:"weight" validate:"min=-3.4028234663852886e+38,max=3.4028234663852886e+38"`
}

An entry in weights with an explicit weight and optional invert flag.

func (WeightsEntry) SchemaTitle ¶ 

func (WeightsEntry) SchemaTitle() string

func (*WeightsEntry) UnmarshalJSON ¶ 

func (v *WeightsEntry) UnmarshalJSON(data []byte) error

func (WeightsEntry) Validate ¶ 

func (v WeightsEntry) Validate() error

type WeightsWeights ¶ 

type WeightsWeights []float64

func (WeightsWeights) SchemaVariantTitle ¶ 

func (WeightsWeights) SchemaVariantTitle() string

Source Files ¶

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.