Arendaja platvorm

OlmoEarth API

Allen Institute for Artificial Intelligence (Ai2) ülevaade arendajatele, mis hõlmab API-juurdepääsu, hinnastust, SDK-tuge, lõppunkte, võimekusi ja platvormi reegleid.

Dokumentatsioon API juhend

API võti Nõutud

Peamine API OlmoEarth API

SDK tugi Ühegi teenusepakkuja spetsiifilist ametlikku SDK-d ei tuvastatud. Interaktiivne API-brauser saab genereerida kliendikoodi levinud programmeerimiskeelte ja teekide jaoks; sobivad ka standardsed HTTP-kliendid.

Päringupiirangud OlmoEarthi API lõpp-punktide avalikke numbrilisi päringupiiranguid ei ole tuvastatud. Platvorm kasutab autentitud kontopõhist juurdepääsu; kvootide üksikasjade kohta vaadake kontopõhist dokumentatsiooni või pöörduge tugikanali poole.

Platvorm

API ülevaade

Lõppunktid (endpoints)

API ligipääs

Juuraadress (Base URL)


					https://olmoearth.allenai.org/api/v1/

Peamine API OlmoEarth API

Hinnad

API Hinnad

Hinnakujundusmudel Päringupõhine juurdepääs platvormile; avalikku standardset API-hinnakirja ei leitud

OlmoEarthi kasutusõigus on saadaval konto taotluse alusel. Läbi vaadatud ametlikust dokumentatsioonist ei leitud avalikku tokeni-, päringu- ega tellimuspõhist API-hinda.

Arendaja töömugavus

SDK info

SDK Ühegi teenusepakkuja spetsiifilist ametlikku SDK-d ei tuvastatud. Interaktiivne API-brauser saab genereerida kliendikoodi levinud programmeerimiskeelte ja teekide jaoks; sobivad ka standardsed HTTP-kliendid.

Kasutusmugavus Mõõdukas kasutusmugavus arendajatele, kes tunnevad REST-i ja GeoJSON-i; saadaval on API-võtmed, interaktiivne dokumentatsioon ja genereeritud kliendinäited, kuid juurdepääs põhineb kontol ning API on spetsialiseerunud Maa seire töövoogudele.

Dokumentatsioon Hea ja ajakohane autentimise, piirkondade halduse, platvormi põhimõistete ja API-de avastamise jaoks. Interaktiivne API-brauser kuvab lõpp-punktide skeeme ja genereeritud näiteid, kuid mõningaid kasutamisega seotud üksikasju, näiteks kvoote ja hinnastust,

Viivitus Avalikku latentsuse sihttaset, teenusetaset ega SLA-d ei leitud. Töökoormus võib varieeruda geograafilise piirkonna, andmestiku, mudeli ja inferentsitoimingu järgi.

Allikad

Viited arendajale

Dokumentatsioon ↗ API juhend ↗ Liivakast ↗

Featuurid

API võimekused

✓ Peenhäälestamine

✓ Liivakast

Lühikirjeldus

OlmoEarth on Ai2 praegune selgelt dokumenteeritud esimese osapoole hallatav API-platvorm. See pakub autentimisega REST-i lõpp-punkte geograafiliste piirkondade haldamiseks ning laiemate töövoogude jaoks, mis hõlmavad andmekogumite loomist, peenhäälestatud mudelite käitamist, embedding'ute loomist ja ennustuste hankimist. API on spetsialiseerunud Maa vaatluse ja georuumilise masinõppe rakendustele, mitte üldotstarbelisele vestluslike suurte keelemudelite teenusele. Ai2 avatud lähtekoodiga keele- ja multimodaalseid mudeleid pakutakse peamiselt allalaaditavate artefaktidena koos dokumentatsiooniga kohapealseks või ise hallatavaks juurutamiseks. Interaktiivne OlmoEarthi API-brauser toetab lõpp-punktide uurimist, otsest testimist ja kliendikoodi genereerimist. Läbi vaadatud ametlik dokumentatsioon ei kinnita OlmoEarthi API puhul üldise vestluse voogedastuse, funktsioonikutsete, püsivate assistentide, struktureeritud generatiivsete väljundite, veebotsingu ega üldotstarbelise failide üleslaadimise toe olemasolu.

Näited

API Näited

set -euo pipefail

: "${OLMOEARTH_API_KEY:?Set OLMOEARTH_API_KEY first}"

curl --fail-with-body --silent --show-error \
  --request POST \
  "https://olmoearth.allenai.org/api/v1/areas" \
  --header "Authorization: Bearer ${OLMOEARTH_API_KEY}" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Nandi County Research Site",
    "geom": {
      "type": "Polygon",
      "coordinates": [[
        [35.1000, 0.1000],
        [35.2000, 0.1000],
        [35.2000, 0.2000],
        [35.1000, 0.2000],
        [35.1000, 0.1000]
      ]]
    }
  }' | python3 -c 'import json,sys; data=json.load(sys.stdin); print(json.dumps(data, indent=2))'

# Install: pip install requests
import json
import os
import sys

import requests

api_key = os.environ.get("OLMOEARTH_API_KEY")
if not api_key:
    raise SystemExit("Set OLMOEARTH_API_KEY before running this script")

url = "https://olmoearth.allenai.org/api/v1/areas"
payload = {
    "name": "Nandi County Research Site",
    "geom": {
        "type": "Polygon",
        "coordinates": [[
            [35.1000, 0.1000],
            [35.2000, 0.1000],
            [35.2000, 0.2000],
            [35.1000, 0.2000],
            [35.1000, 0.1000],
        ]],
    },
}

try:
    response = requests.post(
        url,
        headers={
            "Authorization": f"Bearer {api_key}",
            "Content-Type": "application/json",
        },
        json=payload,
        timeout=60,
    )
    response.raise_for_status()
except requests.HTTPError as exc:
    print(f"HTTP error: {exc}", file=sys.stderr)
    print(response.text, file=sys.stderr)
    raise SystemExit(1)
except requests.RequestException as exc:
    print(f"Request failed: {exc}", file=sys.stderr)
    raise SystemExit(1)

data = response.json()
records = data.get("records", [])
if records:
    print("Created area:", records[0].get("id"))
else:
    print(json.dumps(data, indent=2))

// Install: npm install axios
import axios from "axios";

const apiKey = process.env.OLMOEARTH_API_KEY;
if (!apiKey) {
  throw new Error("Set OLMOEARTH_API_KEY before running this script");
}

const payload = {
  name: "Nandi County Research Site",
  geom: {
    type: "Polygon",
    coordinates: [[
      [35.1000, 0.1000],
      [35.2000, 0.1000],
      [35.2000, 0.2000],
      [35.1000, 0.2000],
      [35.1000, 0.1000]
    ]]
  }
};

try {
  const response = await axios.post(
    "https://olmoearth.allenai.org/api/v1/areas",
    payload,
    {
      headers: {
        Authorization: `Bearer ${apiKey}`,
        "Content-Type": "application/json"
      },
      timeout: 60000
    }
  );

  const records = response.data?.records ?? [];
  if (records.length > 0) {
    console.log("Created area:", records[0].id);
  } else {
    console.log(JSON.stringify(response.data, null, 2));
  }
} catch (error) {
  if (axios.isAxiosError(error)) {
    console.error("Request failed:", error.response?.status, error.response?.data ?? error.message);
  } else {
    console.error("Unexpected error:", error);
  }
  process.exitCode = 1;
}

<?php
$apiKey = getenv('OLMOEARTH_API_KEY');
if (!$apiKey) {
    fwrite(STDERR, "Set OLMOEARTH_API_KEY before running this script\n");
    exit(1);
}

$url = 'https://olmoearth.allenai.org/api/v1/areas';
$payload = [
    'name' => 'Nandi County Research Site',
    'geom' => [
        'type' => 'Polygon',
        'coordinates' => [[
            [35.1000, 0.1000],
            [35.2000, 0.1000],
            [35.2000, 0.2000],
            [35.1000, 0.2000],
            [35.1000, 0.1000],
        ]],
    ],
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json',
        'Accept: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_THROW_ON_ERROR),
    CURLOPT_TIMEOUT => 60,
]);

$body = curl_exec($ch);
if ($body === false) {
    fwrite(STDERR, 'cURL error: ' . curl_error($ch) . "\n");
    curl_close($ch);
    exit(1);
}

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$data = json_decode($body, true);
if ($status < 200 || $status >= 300) {
    fwrite(STDERR, "HTTP $status: $body\n");
    exit(1);
}
if (!is_array($data)) {
    fwrite(STDERR, "Invalid JSON response\n");
    exit(1);
}

if (!empty($data['records'][0]['id'])) {
    echo 'Created area: ' . $data['records'][0]['id'] . PHP_EOL;
} else {
    echo json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES) . PHP_EOL;
}
?>

Põhimõtted

Andmete kasutus

Ai2 üldistes vastutustundliku kasutamise juhistes kirjeldatakse selle tööriistu, sealhulgas mudeleid, andmekogumeid, API-sid ja rakendusi, peamiselt teadus- ja haridusotstarbel kasutamiseks mõelduna ning, kui see on asjakohane, tasuta ja avatud kujul pakutavana. Läbi vaadatud OlmoEarthi API dokumentatsioonis ei ole öeldud, et klientide API kaudu saadetud andmeid kasutatakse Ai2 alusmudelite treenimiseks, samuti ei sisalda see täielikku teenusepõhist treeningandmete kasutamise poliitikat. Kehtivate lepinguliste üksikasjade saamiseks peaksid kasutajad tutvuma OlmoEarthi platvormilepingu, privaatsusmaterjalide ja konto kasutustingimustega.

Andmete säilitamine

Avalikult kättesaadavas OlmoEarthi API dokumentatsioonis ei ole täpsustatud esitatud andmekogumite, alade, prognooside ega API logide täielikku säilitamise ajakava, kustutamise SLA-d ega vaikimisi säilitusaega. Platvormi dokumentatsioon näitab, et alasid ja muid projektiressursse hallatakse konto keskkonnas; teenusepõhiste säilitamis- ja kustutamistingimuste kohta peaksid kasutajad tutvuma kehtiva OlmoEarthi platvormilepingu ja privaatsusdokumentatsiooniga.

Päringupiirangud

OlmoEarthi API lõpp-punktide avalikke numbrilisi päringupiiranguid ei ole tuvastatud. Platvorm kasutab autentitud kontopõhist juurdepääsu; kvootide üksikasjade kohta vaadake kontopõhist dokumentatsiooni või pöörduge tugikanali poole.

Arendaja juhend

OlmoEarth API: algaja juhend Ai2 georuumilisele arendusplatvormile

OlmoEarth API on Ai2 praegune esimese osapoole hallatav arendajaplatvorm Maa vaatluse ja georuumilise masinõppe töövoogude jaoks. See pakub autentimist nõudvaid REST-lõpp-punkte geograafiliste piirkondade haldamiseks ning toetab laiemalt andmekogumite, peenhäälestatud mudelite, manuste ja ennustustega seotud töövooge. Ai2 üldotstarbelised Olmo, Molmo ja Tülu mudelid on peamiselt avalikult välja antud mudelid, mis on mõeldud kohalikuks või ise hallatavaks kasutuselevõtuks, mitte ühe ühtse majutatud vestlus-API kaudu kasutamiseks.

OlmoEarth API võimaldab arendajatel luua georuumilisi rakendusi Ai2 majutatud Maa seire platvormi abil. API kasutab autentitud REST- ja JSON-päringuid ning GeoJSON-i alasid keskse andmestruktuurina. Selles juhendis käsitletakse juurdepääsu, API-võtmeid, esimest päringut, saadaolevaid võimalusi, hinnastamist ja näiteid ning selgitatakse olulist erinevust OlmoEarthi spetsialiseeritud API ja Ai2 avatud mudelite vahel, mida arendajad üldjuhul ise või eraldi majutusteenuse pakkuja kaudu juurutavad.

OlmoEarth API on Ai2 majutatud REST-platvorm Maa vaatluse ja georuumilise masinõppe töövoogude jaoks. See toetab autentitud alade haldust ning laiemaid andmekogumite, peenhäälestuse, embedingute ja ennustuste töövooge, samal ajal kui Ai2 üldotstarbelised keele- ja multimodaalsed mudelid on peamiselt avatult avaldatud ning mõeldud ise juurutamiseks. Juhend käsitleb juurdepääsu, API-võtmeid, esimesi päringuid, hinnastamist, arendajatööriistu, võimaluste piire ja tootmiskeskkonnaga seotud kaalutlusi.

Mis on OlmoEarth API ja millal seda kasutada?

OlmoEarth API on tehisintellekti uurimisega tegeleva Allen Institute for Artificial Intelligence’i ehk Ai2 majutatud REST API. See on mõeldud Maa seire ja georuumilise masinõppe töövoogude jaoks, mitte üldiseks vestluslikuks tehisintellektiks. REST API on veebiteenus, mida rakendused HTTP kaudu kutsuvad; päringuid ja vastuseid vahetatakse JSON-andmetena.

Platvormi saab kasutada geograafiliste alade haldamiseks, andmekogumite loomiseks, peenhäälestatud mudelite käivitamiseks, esituste genereerimiseks ja ennustuste hankimiseks. Ala esitatakse GeoJSON-geomeetriana, näiteks WGS84 koordinaate kasutava Polygon- või MultiPolygon-ina. Seetõttu sobib OlmoEarth rakendustele, mis analüüsivad Maa piirkondi, mitte rakendustele, mis vajavad üldotstarbelist tekst assistenti.

Ai2 laiemasse arendajaökosüsteemi kuuluvad avatud Olmo keelemudelid, multimodaalsed Molmo mudelid, Tülu ja seotud teadustöö tulemused. Need mudelid laaditakse üldjuhul alla ja käitatakse kohapeal või juurutatakse arendaja valitud taristus. Ai2 ei paku üht üldotstarbelist majutatud keelemudeli API-t, mis oleks võrreldav tavapärase vestluse lõpetamise teenusega. Kasutage OlmoEarthi siis, kui vajate selle majutatud georuumilisi töövooge; kui soovite mudeli juurutamist ise hallata, tutvuge Ai2 avatud mudelite dokumentatsiooniga.

Kellele API mõeldud on?

OlmoEarth sobib arendajatele, uurimisrühmadele ja organisatsioonidele, kes loovad rakendusi satelliidi- või muude Maa seire andmete, geograafiliste piirkondade, georuumiliste andmekogumite, mudelite peenhäälestamise, esituste ja ennustuste hankimise ümber. HTTP-päringute, JSON-i ja GeoJSON-i põhiteadmised tulevad kasuks, kuid esimese API-päringu tegemiseks ei pea olema masinõppe ekspert.

See ei sobi hästi juhul, kui peamine vajadus on majutatud vestlusrobot, üldine teksti genereerimine, ühtne pildigeneratsiooni teenus või tavapärane assistendi API, millel on vestlusseisundi haldus ja tööriistade kutsumine. Ai2 avatud mudelid võivad sobiva taristu abil toetada laiemaid rakendusi, kuid ei tohiks eeldada, et need võimalused on OlmoEarthi kaudu saadaval.

Juurdepääsu saamine ja API-võtme hankimine

OlmoEarth kasutab kontopõhist juurdepääsu. Ai2 kirjeldab platvormi praegu kättesaadavana ja suunab potentsiaalsed kasutajad juurdepääsu taotlema. Pärast juurdepääsu andmist kasutatakse autentimiseks OlmoEarth Studios loodud kandjaluba.

API-võtmeid saab kasutaja profiilis luua, ümber nimetada ja tühistada. Dokumentatsiooni kohaselt võib kontol olla kuni 10 võtit. Salvestage võti serveripoolse keskkonnamuutujana, näiteks OLMOEARTH_API_KEY. Ärge paigutage seda brauseri JavaScripti, mobiilirakenduse koodi, avalikesse hoidlatesse ega kliendipoolsesse HTML-i, sest igaüks, kes saab seda koodi kontrollida, võib mandaadi kopeerida.

Võti saadetakse HTTP-päises standardvormingus kandjaloana:

Authorization: Bearer YOUR_OLMOEARTH_API_KEY

Ai2 avatud mudelite allalaadimiseks ja kohapeal käitamiseks ei ole üldjuhul Ai2 järeldus-API võtit vaja. Konkreetsete andmekogumite, piiratud juurdepääsuga hoidlate, majutatud demode või kolmandate osapoolte järeldusteenuste puhul võivad siiski kehtida eraldi juurdepääsunõuded.

Sobiva Ai2 API- või mudelitee valimine

Nõue	Soovitatav tee	Mida oodata
Majutatud georuumilised töövood	OlmoEarth API	Autenditud REST-i lõpp-punktid alade ning laiemate andmekogumi-, mudeli-, esituse- ja ennustusvoogude jaoks.
Üldotstarbeline keelemudelite arendus	Avatud Olmo väljalasked	Laadige mudelid alla ja käitage neid kohapeal või juurutage need arendaja valitud taristus.
Multimodaalsete mudelite arendus	Avatud Molmo väljalasked	Kasutage mudelite artefakte ja juurutusjuhiseid, mitte ärge eeldage ühtset Ai2 majutatud multimodaalset lõpp-punkti.
Teise operaatori pakutav majutatud järeldusteenus	Ühilduv kolmanda osapoole pakkuja	Autentimise, hinnoittel, piirangute, tööaja ja andmepoliitika määrab see pakkuja.

Ai2 juurutusnäites kuvatud OpenAI-ga ühilduv server ei ole automaatselt Ai2 hallatav lõpp-punkt. Enne integreerimist kontrollige serveri operaatorit, baas-URL-i, autentimismeetodit, saadaolevat mudelit, teenusetingimusi ja tööpiiranguid.

Esimese OlmoEarth API-päringu tegemine

Dokumenteeritud API baas-URL on https://olmoearth.allenai.org/api/v1/. Järgmine näide loob GeoJSON Polygoniga ala. Koordinaadid kasutavad WGS84 järjestuses pikkus- ja laiuskraadi ning hulknurk suletakse esimese koordinaadi kordamisega.

set -euo pipefail

: "${OLMOEARTH_API_KEY:?Set OLMOEARTH_API_KEY first}"

curl --fail-with-body --silent --show-error 
  --request POST 
  "https://olmoearth.allenai.org/api/v1/areas" 
  --header "Authorization: Bearer ${OLMOEARTH_API_KEY}" 
  --header "Content-Type: application/json" 
  --data '{
    "name": "Nandi County Research Site",
    "geom": {
      "type": "Polygon",
      "coordinates": [[
        [35.1000, 0.1000],
        [35.2000, 0.1000],
        [35.2000, 0.2000],
        [35.1000, 0.2000],
        [35.1000, 0.1000]
      ]]
    }
  }'

Enne käivitamist määrake võti oma shellis:

export OLMOEARTH_API_KEY='replace-with-your-key'

Vastav Pythoni näide kasutab laialt toetatud requests HTTP-teeki. See hoiab võtme lähtekoodist eemal ja rakendab ajalõpu, et protsess ei jääks võrguvastust lõputult ootama.

# Install: pip install requests
import os
import sys
import requests

api_key = os.environ.get("OLMOEARTH_API_KEY")
if not api_key:
    raise SystemExit("Set OLMOEARTH_API_KEY before running this script")

url = "https://olmoearth.allenai.org/api/v1/areas"
payload = {
    "name": "Nandi County Research Site",
    "geom": {
        "type": "Polygon",
        "coordinates": [[
            [35.1000, 0.1000],
            [35.2000, 0.1000],
            [35.2000, 0.2000],
            [35.1000, 0.2000],
            [35.1000, 0.1000],
        ]],
    },
}

try:
    response = requests.post(
        url,
        headers={
            "Authorization": f"Bearer {api_key}",
            "Content-Type": "application/json",
        },
        json=payload,
        timeout=60,
    )
    response.raise_for_status()
except requests.HTTPError as exc:
    print(f"HTTP error: {exc}", file=sys.stderr)
    print(response.text, file=sys.stderr)
    raise SystemExit(1)
except requests.RequestException as exc:
    print(f"Request failed: {exc}", file=sys.stderr)
    raise SystemExit(1)

print(response.json())

Vastuste mõistmine

Õnnestunud päring tagastab API-st JSON-i. Kaasasolev integratsiooninäide kontrollib records massiivi ja loeb esimese loodud ala identifikaatori. Täpsed vastuseväljad tuleks üle kontrollida aktiivsest API viitest, sest skeemid võivad platvormi arenedes muutuda.

Enne vastuse edukaks lugemist kontrollige alati HTTP olekukoodi. Tootmiskoodis logige kasulikke päringuidentifikaatoreid ja ohutuid veadetaile, kuid ärge kunagi logige API-võtit. Ebaõnnestunud päringute korral säilitage arenduse ajal vastuse keha, sest see võib selgitada valideerimis-, autentimis- või juurdepääsuprobleeme.

Pärast ala loomist hõlmavad dokumenteeritud alahaldustoimingud konkreetse ala hankimist käsuga GET /areas/{area_id}, alade otsimist käsuga POST /areas/search, ühe ala uuendamist käsuga PUT /areas/{area_id} ja kustutamist käsuga DELETE /areas/{area_id}. Praeguste skeemide uurimiseks ja päringute proovimiseks saab kasutada interaktiivset API-brauserit.

Kuidas hinnastamine ja juurdepääs üldjoontes toimivad?

Vaadatud ametlikust dokumentatsioonist ei leitud OlmoEarthi kohta avalikku standardset tokeni-, päringu- ega tellimusepõhist hinda. Juurdepääs toimub konto kaudu taotluse alusel ning potentsiaalsed kasutajad võivad vajada platvormile juurdepääsu taotlemist.

Samuti ei avalda Ai2 vaadatud materjalides ühtset tokenipõhise hinnastamise tabelit üldise majutatud keelemudeli API kohta. Avatud mudelite allalaadimine ja ise hallatav käitamine võib vältida Ai2 majutatud järeldusteenuse tasu, kuid arendaja peab siiski tagama sobiva arvutusvõimsuse, salvestusruumi, võrgu ja halduse. Kui kolmanda osapoole pakkuja majutab Ai2 mudelit, kehtivad selle pakkuja hinnad ja tingimused.

Enne tootmiskoormuse kasutuselevõttu kinnitage kehtivad ärilised tingimused, kvoodid ja kontopõhised nõuded. Ärge hinnake kulusid teise pakkuja tokenihinna põhjal.

Võimalused: mis on dokumenteeritud ja mis mitte?

OlmoEarthi kõige selgemalt dokumenteeritud võimalused on:

Autenditud REST- ja JSON-päringud.
Geograafiliste alade loomine, hankimine, otsimine, uuendamine ja kustutamine.
WGS84 koordinaate kasutavad GeoJSON Polygon- ja MultiPolygon-alade määratlused.
Andmekogumite programmiliselt loomine.
Peenhäälestatud mudelite käitamine.
Esituste genereerimine.
Ennustuste hankimine.

Vaadatud dokumentatsioon ei kinnita järgmisi OlmoEarthi funktsioone:

Vestluse voogedastus.
Funktsioonide või tööriistade kutsumine.
Püsivad assistendid või vestlusmälu.
Struktureeritud tekstiväljundi skeemid või eraldi JSON-režiim.
Üldised pildi- või faililaadimised sellisel kujul, nagu generatiivse tehisintellekti API-d neid tavaliselt pakuvad.
Veebiotsing.

Neid kinnitamata üksusi tuleks käsitleda teadmata, mitte igaveseks toetamata funktsioonidena; muudatuste kontrollimiseks vaadake praegust API viidet. Ai2 avatud mudeleid saab kasutada multimodaalsetes või tööriistu kasutavates süsteemides, kui arendajad tagavad mudeli juurutuse ja ümbritseva rakenduse taristu, kuid see ei tõesta sama võimaluse olemasolu OlmoEarthis.

SDK-d, API viide ja mänguväljaku tööriistad

Vaadatud materjalidest ei leitud teenusepakkuja ametlikku SDK-d. Seetõttu on praktilised integratsioonivalikud standardsed HTTP-kliendid, näiteks curl, Pythoni requests, JavaScripti HTTP-teegid või PHP cURL.

OlmoEarthi interaktiivne API-brauser on peamine arendajatööriist. See pakub lõpp-punktide skeeme, võimaldab autenditud kasutajal päringuid uurida ja proovida ning genereerib kliendikoodi levinud keelte ja teekide jaoks. Kasutage seda päringu- ja vastuseväljade kinnitamiseks, mitte ärge kopeerige eeldusi teistest AI API-dest.

API viide on saadaval aadressil docs.olmoearth.allenai.org/api/. Dokumentatsiooni veebisaiti ja OlmoEarth Studiot tuleks käsitleda praeguste juurdepääsunõuete ja lõpp-punktide käitumise ametliku allikana.

Täpsemad integratsioonimustrid

Hallake ala ressursina

Tüüpiline rakendus võib luua ala üks kord, säilitada tagastatud identifikaatori ja kasutada seda hilisemates töövoogudes. Praeguse oleku kuvamisel hankige ressurss, olemasolevate alade leidmisel kasutage otsingu lõpp-punkti ning uuendage või kustutage ala alles pärast kavandatud konto ja alaidentifikaatori kinnitamist.

curl --fail-with-body --silent --show-error 
  --request GET 
  "https://olmoearth.allenai.org/api/v1/areas/AREA_ID" 
  --header "Authorization: Bearer ${OLMOEARTH_API_KEY}" 
  --header "Accept: application/json"

Täpne otsingu keha ja vastuse skeem tuleks võtta praegusest interaktiivsest API viitest. Vältige väljade väljamõtlemist teise georuumilise API tavade põhjal.

Eraldage platvormitoimingud rakenduse loogikast

Tootmisteenuses hoidke OlmoEarthi kutsed serveripoolse rakenduskihi taga. See kiht saab enne saatmist GeoJSON-i valideerida, siduda platvormiressursside identifikaatorid sisemiste kirjetega, korrata ohutuid päringuid ja takistada kasutajatel mandaatidele juurdepääsu. Samuti saab see eristada ajutisi võrgutõrkeid püsivatest valideerimis- või autoriseerimistõrgetest.

Andmekogumi ettevalmistamine, peenhäälestamine, esituste genereerimine ja ennustuste hankimine on eraldiseisvad ülesanded ka siis, kui need moodustavad ühe rakenduse töövoo. Jälgige iga toimingu olekut ja säilitage piisavalt metaandmeid, et tuvastada, milline ala, andmekogum, mudel ja parameetrid tulemuse tekitasid.

Piirangud ja tootmiskasutuse kaalutlused

Vaadatud OlmoEarthi dokumentatsioonist ei leitud avalikke arvulisi päringupiiranguid. Samuti ei leitud sealt avalikku latentsuseesmärki, teenusetaset ega teenusetaseme lepingut. Jõudlus võib varieeruda sõltuvalt geograafilisest alast, andmekogumist, mudelist ja järeldustoimingust.

Kasutage piiratud kestusega ajalõppe, kontrollige HTTP olekukoode ja rakendage eksponentsiaalset taastekordust ainult seal, kus kordamine on ohutu. Muutvad toimingud, näiteks loomine ja uuendamine, võivad pärast võrguaegumist pimesi kordamisel tekitada duplikaate. Seetõttu lisage rakendustaseme idempotentsuskaitsed või kooskõlastage ressurss hiljem.

Vaadatud dokumentatsioon ei sisalda täielikku säilitusgraafikut, kustutamise teenusetaseme lepingut ega esitatud andmekogumite, alade, ennustuste või API-logide vaikimisi säilitusaega. Enne tundliku või konfidentsiaalse materjali saatmist tutvuge kehtiva platvormilepingu ja privaatsusdokumentatsiooniga. Kontrollige ka mudeli- ja andmekogumikaarte, vastutustundliku kasutuse juhiseid ning litsentsipiiranguid; mõnele Ai2 artefaktile võivad kehtida akadeemilise, mitteärilise või muu kasutuse tingimused.

Ärge eeldage, et kohalikul või kolmanda osapoole juurutusel on sama tööaeg, päringupiirangud, voogedastuse käitumine, tööriistade tugi või andmete säilitamise poliitika nagu OlmoEarthil. Need omadused sõltuvad tegelikust teenuseoperaatorist.

Millal on OlmoEarth API hea või halb valik?

OlmoEarth on hea valik, kui rakendus vajab Ai2 majutatud georuumilisi ressursse ja töövooge, eelkõige alade haldamist, Maa seire andmekogumeid, peenhäälestatud georuumilisi mudeleid, esitusi või ennustusi. See on ka mõistlik lähtekoht uurimisprototüübile, mis saab kasutada REST-i ja GeoJSON-i ning ei vaja avaldatud tokenipõhist hinnastusmudelit ega avalikke arvulisi kvoote.

See on halb valik, kui põhivajadus on üldine majutatud vestlus-API, garanteeritud voogedastus, funktsioonide kutsumine, püsivad assistendid, veebiotsing või dokumenteeritud üldine faililaadimise liides. See võib olla ebasobiv ka juhul, kui organisatsioon vajab avalikke SLA-kohustusi, avaldatud päringupiiranguid, teenusepakkuja hallatavat SDK-d või selgelt määratletud andmete säilitamise tingimusi, mida vaadatud dokumentatsioonis ei ole.

Peamine arhitektuuriline otsus on, kas kasutada spetsialiseeritud majutatud georuumilist platvormi või juurutada avatud Ai2 mudel ise. Tehke valik töökoormuse, vajaliku kontrolli, tegevuseelarve, andmepiirangute ja käitatava teenuse jaoks dokumenteeritud täpsete võimaluste põhjal.

Allikad 8

allenai.org/olmoearth ↗ docs.olmoearth.allenai.org ↗ docs.olmoearth.allenai.org/authentication/ ↗ docs.olmoearth.allenai.org/api/ ↗ docs.olmoearth.allenai.org/area-management/ ↗ docs.allenai.org/quick_start/running_locally_lmstudio ↗ allenai.org/responsible-use ↗ olmoearth.allenai.org/eula ↗