Go SDK Reference

ctx := context.Background()

db, err := onyx.New(ctx, onyx.Config{})

ctx := context.Background()

db, err := onyx.New(ctx, onyx.Config{
  ApiKey: "YOUR_API_KEY", 
  ApiSecret: "YOUR_API_SECRET"
})

acct := &onyx.Account{
  Id: "acct_cascade",
  Name: "Primary",
  Balance: 0,
  Transactions: []onyx.Transaction{
    {Id: "txn_1", AccountId: "acct_cascade", Amount: 250, Currency: "USD"},
    {Id: "txn_2", AccountId: "acct_cascade", Amount: 125, Currency: "USD"},
  },
}

err := db
  .Cascade("transactions:Transaction(accountId, id)")
  .Save(ctx, onyx.TableAccount, acct)

rel := db
  .CascadeBuilder()
  .Graph("Transactions")
  .GraphType("Transaction")
  .TargetField("AccountId")
  .SourceField("Id")

fmt.Println(rel.String()) // transactions:Transaction(accountId, id)

tx, err := db.Transactions().Resolve("account").Find(ctx, "txn_123")

rows, err := db.Transactions()
  .Where(onyx.Eq("status", "posted"))
  .Resolve("account")
  .List(ctx)

rows, err := db.Transactions()
  .Where(onyx.Eq("account.name", "Primary"))
  .Resolve("account")
  .List(ctx)

import sdk "github.com/OnyxDevTools/onyx-database-go/onyx"

minScore := 0.4
hits, err := db.Core().From("ActiveDocumentChunk").
  SearchWithOptions(
    "how do i calculate cost per horse",
    sdk.SearchOptions{
      Mode:          sdk.SearchModeLexical,
      Match:         sdk.SearchMatchAny,
      MinScore:      &minScore,
      MaxCandidates: 500,
    },
  ).
  List(ctx)

import sdk "github.com/OnyxDevTools/onyx-database-go/onyx"

related, err := db.Core().From("ActiveDocumentChunk").
  SearchWithOptions(
    "expense for each animal",
    sdk.SearchOptions{Mode: sdk.SearchModeSemantic},
  ).
  List(ctx)

import sdk "github.com/OnyxDevTools/onyx-database-go/onyx"

results, err := db.Core().From("ActiveDocumentChunk").
  SearchWithOptions(
    "how do i calculate cost per horse",
    sdk.SearchOptions{},
  ).
  And(sdk.Eq("isActive", true)).
  Limit(50).
  List(ctx)

import sdk "github.com/OnyxDevTools/onyx-database-go/onyx"

acrossTables, err := db.Core().
  SearchWithOptions(
    "how do i calculate cost per horse",
    sdk.SearchOptions{Mode: sdk.SearchModeHybrid},
  ).
  Limit(50).
  List(ctx)

legacy, err := db.Core().From("ActiveDocumentChunk").
  Search("cost per horse").
  List(ctx)

import sdk "github.com/OnyxDevTools/onyx-database-go/onyx"

signature, err := sdk.NewSemanticVectorSignature(
  73,
  6,
  []int{1, 2},
  []int{4, 4},
  []int64{0x123456789abcdef0},
)
if err != nil { panic(err) }

radius, score, allTerms := 2, 0.2, false
query, err := sdk.NewVectorSearchQuery(sdk.VectorSearchQueryInput{
  Text:               "AWS spend",
  Semantic:           &signature,
  MinScore:           &score,
  NearbyBucketRadius: &radius,
  MaxCandidates:      256,
  RequireAllTerms:    &allTerms,
})
if err != nil { panic(err) }

hits, err := db.Core().From("Transaction").SearchVector(query).List(ctx)

import sdk "github.com/OnyxDevTools/onyx-database-go/onyx"

bounded, err := sdk.NewVectorSearchQuery(sdk.VectorSearchQueryInput{
  Text:          "AWS spend",
  MaxCandidates: 250,
})
if err != nil { panic(err) }

candidates, err := db.Core().From("Transaction").
  ApproximateSearch(bounded).
  List(ctx)

import sdk "github.com/OnyxDevTools/onyx-database-go/onyx"

minScore := 0.2
hnsw, err := sdk.NewHNSWSearchQuery(sdk.HNSWSearchQueryInput{
  CalibrationID: 73,
  Vector:        embedding,
  MaxCandidates: 256,
  EFSearch:      1024,
  MinScore:      &minScore,
})
if err != nil { panic(err) }

nearest, err := db.Core().From("Transaction").HNSWCandidates(hnsw).List(ctx)

import sdk "github.com/OnyxDevTools/onyx-database-go/onyx"

routed, err := db.Core().From("Transaction").
  Where(sdk.ApproximateCandidates("merchant", []string{"AWS", "GCP"}, 200)).
  And(sdk.Eq("status", "posted")).
  List(ctx)

resp, err := db.Chat(ctx, onyx.AIChatCompletionRequest{
  Model: "onyx",
  Messages: []onyx.AIChatMessage{
    {Role: "system", Content: "You are a finance assistant. Respond with 3 concise bullet points."},
    {Role: "assistant", Content: "I summarize trends and call out anomalies each Friday."},
    {Role: "user", Content: "Draft a status update for finance stakeholders."},
  },
})
fmt.Println(resp, err)

stream, err := db.ChatStream(ctx, onyx.AIChatCompletionRequest{
  Model: "onyx",
  Stream: true,
  Messages: []onyx.AIChatMessage{{Role: "user", Content: "List the top 3 spend categories this week."}},
})
defer stream.Close()
for stream.Next() {
  chunk := stream.Value()
  fmt.Println(chunk)
}
err = stream.Err()

resp, err := db.Chat(ctx, onyx.AIChatCompletionRequest{
  Model: "onyx",
  Messages: []onyx.AIChatMessage{
    {Role: "user", Content: "Summarize yesterday's transactions in two bullets."},
  },
})
summary := resp.Choices[0].Message.Content
fmt.Println(summary, err)

models, err := db.GetModels(ctx)
for _, m := range models.Data {
  fmt.Println(m.ID)
}

model, err := db.GetModel(ctx, "onyx")
fmt.Println(model, err)

resp, err := db.RequestScriptApproval(ctx, onyx.AIScriptApprovalRequest{
  Script: "db.Save({ id: 'acct_1', name: 'Checking' })",
})
fmt.Println(resp, err)

payload := []byte("hello")
err := db.Documents().Save(ctx, onyx.Document{
  DocumentId: "hello.txt",
  Path:       "/docs/hello.txt",
  MimeType:   "text/plain",
  Content:    payload,
})

doc, err := db.Documents().Get(ctx, "hello.txt", nil)
fmt.Println(doc, err)

err := db.Documents().Delete(ctx, "hello.txt")

secrets, err := db.OnyxSecrets().List(ctx)
fmt.Println(secrets, err)

secret, err := db.OnyxSecrets().Get(ctx, "stripe_api_key")
fmt.Println(secret, err)

err := db.OnyxSecrets().Set(ctx, onyx.OnyxSecret{
  Key:     "stripe_api_key",
  Value:   "sk_live_...",
  Purpose: "Stripe server key",
})

err := db.OnyxSecrets().Delete(ctx, "stripe_api_key")