Autonomy dokumentatsioon
HTTP API v1

Käivitused ja tõendid

Jälgi käivitust lõpuni, loe selle tulemust ja Step Actions'it ning hangi lühiajalised tõendilingid.

run.trigger lisab käivitused järjekorda ja tagastab kohe. Jälgi iga tagastatud runId-d toiminguga run.get, loe toiminguga run.step_actions, mida agent tegi, ja hangi toiminguga run.evidence tõendid iga sammu tulemuse taga.

Jälgi käivitust kursoriga

Esimene run.get päring vajab ainult käivituse ID-d. See tagastab kohe:

Codejson
1{2  "runId": "jh7examplerunid"3}

Salvesta vastusest numbriline cursor. Muutuse ootamiseks saada käivituse ID, see kursor ja waitMs:

Codejson
1{2  "runId": "jh7examplerunid",3  "cursor": 42,4  "waitMs": 250005}

Päring tagastab kohe, kui käivitus muutub (selle kursor suureneb) või jõuab lõppolekusse. waitMs võib olla 0 kuni 25000 millisekundit; suuremaid väärtusi käsitletakse kui 25000. Kui selle aja jooksul midagi ei muutunud, on vastuses timedOut: true. See ei ole viga: saada sama kursor uuesti või lõpeta ootamine.

Lõppolekud on passed, failed, couldnt_start ja cancelled.

Mida run.get tagastab

VäliMida see sisaldab
statusKäivituse tulemus (vaata allolevat tabelit).
flakytrue, kui käivitus läbis, kuid mõni samm vajas kordust.
progressSammud kujul { completed, total }.
stepsÜks kirje iga sammu ja platvormi kohta: index, platform, outcome (samm nii, nagu see on kirjutatud), state, result ning teadaolevatel juhtudel failureCategory, flaky ja retryCount.
createdResourcesKontod, postkastid, telefoninumbrid ja failid, mille käivitus lõi, igaühel label, identifier (aadress, number või kasutajanimi, mitte kunagi saladus), stepIndex ja koristamise olek cleanup.
evidence.availableKas run.evidence saab juba midagi tagastada.
nextSoovitus, mida edasi teha.
cursor, timedOutOotamiseks, nagu eespool kirjeldatud.

Vastuses on ka käivituse kokkuvõte, mille tagastab run.list: runId, projectId, testCaseId, testCaseName, platforms, environment, trigger (haru, PR, commit), planGroupRunId, startedAt ja completedAt.

Käivituse olek

status kasutab samu käivituse tulemusi nagu töölaud:

statusTöölaudTähendus
queuedQueuedOotab vaba runnerit.
runningRunningKäimas.
passedPassedIga samm jõudis oma oodatud tulemuseni ja iga Final check on sellega kooskõlas. Vaata välja flaky.
failedFailedMõni samm ei jõudnud oma oodatud tulemuseni või agent ei suutnud näidata, et see jõudis. Iga läbikukkunud sammu explanation ütleb, miks.
couldnt_startCouldn't startKeskkonda ei saanud testida, seega ühtegi sammu ei käivitatud. Arvet ei esitata.
cancelledCancelledKeegi peatas käivituse.

Kui kasutad käivitusi CI väravana, loe läbinuks ainult passed. Enne seda muudatust salvestatud käivitused, mille tulemust ei saanud tõestada, tagastatakse olekuga failed koos nende põhjusega.

Sammu olek ja tulemus

Igal sammul on state: not_run (pole veel jõutud või käivitus peatus või ei saanud enne alata), running, finished või cancelled. Ainult lõpetatud sammul on result:

resultTöölaudTähendus
passedPassedSamm jõudis oma oodatud tulemuseni.
failedFailedSamm ei jõudnud oma oodatud tulemuseni või agent ei suutnud näidata, et see jõudis.
nullSamm pole lõppenud.

Kui põhjus on teada, on failureCategory väärtus app_bug, test_flaky, environment, test_error, runner või unknown. runner tähendab, et midagi läks katki Autonomy poolel, näiteks AI-mudel polnud saadaval või runneri brauser peatus. Autonomy käivitab sellise käivituse automaatselt ühe korra uuesti; kui see läheb jälle katki, on see failed ja töölaual on sellel silt Runner problem, ning nende katsete eest arvet ei esitata. Samm, millel sai aeg otsa, on environment, mitte runner.

next

next on soovitus, mitte kunagi määrav juhis. Otsusta väljade status ja steps põhjal.

nextMillal
waitKäivitus on olekus queued või running.
evidenceKäivitus on olekus failed või passed koos väärtusega flaky: true.
retryKäivitus on olekus couldnt_start.
noneKõik muu.

Loe Step Actions'it

run.step_actions loetleb kõik, mida agent iga sammu oodatud tulemuseni jõudmiseks tegi, järjestatuna iga tegevuse alguse aja järgi:

Codejson
1{2  "runId": "jh7examplerunid",3  "stepIndex": 0,4  "limit": 1005}

Igal kirjel on actionId, stepIndex (null käivituse tasandi töö puhul, nagu ettevalmistus ja koristamine), platform, kind, label, valikulised summary ja detail, outcome (running, ok või error), startedAt ja endedAt. kind on üks järgmistest:

  • tool: tegevus rakenduses, postkastis või telefonis.
  • final_check: värske pilk tootele, millega sammu tulemus peab kooskõlas olema.
  • cleanup: käivituse loodu eemaldamine.
  • note: midagi, mille agent teel üles märkis.

Väärtused, mille käivitus lõi või sai, on näidatud sellisena, nagu need olid; väärtused, mille salvestasid saladustena, on maskeeritud ega ilmu kunagi nähtavale.

Iga vastus on hetktõmmis ja selle cursor lehitseb seda ühte hetktõmmist. Tegevused võivad saabuda hiljem ja varasema alguse ajaga, nii et kursor ei saa käimasolevat käivitust jälgida. Igas vastuses on runCursor, sama loendur, mis run.get väljal cursor. Kuni käivitus käib, ja ka pärast selle lõppu, kui koristamisest veel teatatakse, loe iga kord algusest uuesti, kui runCursor muutub. Kui see pole pärast sinu viimast täielikku lugemist muutunud, pole midagi uut.

Hangi tõendid

Kutsu run.evidence väljaga runId ja soovi korral numbrilise väljaga step:

Codejson
1{2  "runId": "jh7examplerunid",3  "step": 14}

Vastus on kujul { run: { runId, status }, steps }, kus on üks kirje iga käivitatud sammu kohta:

VäliMida see sisaldab
stepIndex, platformMilline samm.
outcomeSammu oodatud tulemus nii, nagu see on kirjutatud.
resultpassed või failed.
explanationÜks rida selle kohta, mida tõendid näitavad või miks samm läbi kukkus.
failureCategoryTeadaolevatel juhtudel: app_bug, test_flaky, environment, test_error, runner või unknown.
finalCheck{ agrees, detail }: kas Final check on tulemusega kooskõlas.
mediaEkraanipildid, kaadrid ja video, igaühel allkirjastatud url ja expiresAt.
durationMsKui kaua samm kestis.

Tõendid ei sisalda kunagi AI-mudeli ega pakkuja nimesid, viipasid, tokenite ega kulude arve, sisemisi vigu ega töötlemata ekraaniandmeid.

Allkirjastatud meedialingid

Iga meedia url näeb välja selline:

Codetext
GET https://api.autonomyqa.com/api/v1/evidence/<id>?kind=<screenshot|frame|video>&exp=<epoch-ms>&sig=<signature>

Link töötab 15 minutit ega vaja Beareri mandaati: luba kannab allkiri. Kehtiv link suunab (302) failile. Kehtetu või aegunud link tagastab 403 sõnumiga „The evidence link is invalid or has expired.“; puuduv meedia tagastab 404. Värskete linkide saamiseks kutsu run.evidence uuesti. Ära muuda päringustringi.

Keskkonna väärtused ja saladused

Keskkonnad hoiavad nimetatud väärtusi, mida sammud kasutavad kujul {{env.NAME}} oodatud tulemuse tekstis või manuse väljadel value, address või number. Iga käivitus täidab need selle keskkonna põhjal, kus see toimub. Siin kasutab samm keskkonda salvestatud kutsekoodi:

Codejson
1{2  "id": "join",3  "text": "The grower joins the cooperative with the invite code",4  "attachments": [5    {6      "id": "invite-code",7      "kind": "data",8      "label": "Invite code",9      "value": "{{env.COOP_INVITE_CODE}}",10      "exact": true11    }12  ]13}

Saladuseks märgitud väärtust saab ainult kirjutada. environment.list ja environment.get tagastavad ainult väärtuste nimed (runtimeValueNames), mitte kunagi väärtusi. Kui runner käivituse vastu võtab, saadab Autonomy talle saladused, millele sammud viitavad. Need täidetakse viitena, nii et agent ei näe neid kunagi, ja need on Step Actions'is, tõendites ja logides maskeeritud. API ei tagasta kunagi saladuse väärtust.

Värske API-sihtmärgi puhul saab run.trigger väärtused kaasa anda väljal targets.api.runtimeValues. Kuidas väärtusi töölaual hallata, vaata lehelt Keskkonnad.

Ei leidnud?

On this page