ChartQuery

Ruby

Installez le SDK Ruby de ChartQuery et faites votre premier appel d'API.

Le SDK Ruby officiel de ChartQuery, avec une méthode typée par endpoint et un request() générique pour le reste.

Prérequis

  • Ruby 3.1+

Installation

gem install chartquery
Gemfile
gem "chartquery"

Obtenir votre clé API

Copiez votre clé API depuis le tableau de bord ChartQuery et placez-la dans la variable d'environnement CHARTQUERY_API_KEY, que le SDK lit par défaut. Ne la versionnez pas.

Démarrage rapide

require "chartquery"

client = ChartQuery::Client.new(api_key: ENV.fetch("CHARTQUERY_API_KEY"))
response = client.chart_ai(prompt: "Monthly revenue 2026 as a bar chart: Jan 10, Feb 14, Mar 18")
puts response.data

Jobs asynchrones

Tout appel accepte is_async, utile au-delà de la limite serveur de 60 secondes. La réponse est alors un job_id, et le SDK peut attendre la fin du job.

submitted = client.chart_ai(prompt: "Monthly revenue 2026 as a bar chart: Jan 10, Feb 14, Mar 18", is_async: true)
job = client.wait_for_job(submitted.data["job_id"]) { |j| puts "#{j['status']} #{j['progress']}%" }
puts job.data

Erreurs

Une réponse hors 2xx lève une erreur d'API avec son statut et son message. Consultez les codes de statut pour la liste complète.

begin
  client.chart_ai(prompt: "Monthly revenue 2026 as a bar chart: Jan 10, Feb 14, Mar 18")
rescue ChartQuery::APIError => e
  warn "HTTP #{e.status}: #{e.message}"
end

Nouvelles tentatives

Les requêtes sont retentées jusqu'à 3 fois après une erreur réseau, un 408, 500, 502, 503 ou 504, ou une limite de débit du forfait. Les erreurs de quota par clé et les expirations côté client ne sont pas retentées. Le délai commence à 1 seconde et augmente de 1,5× à chaque tentative, et un en-tête Retry-After a la priorité.

client = ChartQuery::Client.new(max_retries: 5, retry_delay: 0.5)
client.chart_ai(prompt: "Monthly revenue 2026 as a bar chart: Jan 10, Feb 14, Mar 18", request_options: { max_retries: 0 }) # one request without retries

Requêtes par lots

Lancez plusieurs appels à la fois, 10 par défaut. Un échec n'arrête pas les autres.

inputs = ["Monthly revenue 2026 as a bar chart: Jan 10, Feb 14, Mar 18", "Market share as a pie chart: A 40, B 35, C 25"]
results = client.batch(inputs, concurrency: 5) { |value| client.chart_ai(prompt: value) }
results.each do |result|
  if result.ok?
    puts result.value.data
  else
    warn "#{inputs[result.index]}: #{result.error.message}"
  end
end

N'importe quel endpoint

request() atteint n'importe quel chemin, y compris les endpoints sortis après votre version du SDK.

response = client.request("GET", "/v1/usage")

Erreurs fréquentes

  • Mettre la clé API dans le code front-end. N'importe qui pourrait la lire. Appelez l'API depuis votre serveur.
  • Considérer tout 401 comme une mauvaise clé. Un 401 peut aussi signaler une limite de débit : lisez le message. Le SDK retente pour vous les limites du forfait.
  • Retenter un 402. Il n'y a plus de crédits ni de quota, donc une nouvelle tentative ne peut pas réussir. Consultez Crédits.
  • Attendre les requêtes longues. Au-delà de 60 secondes, utilisez le mode asynchrone comme ci-dessus plutôt que d'augmenter votre délai. Voir Timeout.

Liens

Sur cette page