PM: API: Goal: PATCH /planning-api/goals/{goalId}/ai-description
Üldkirjeldus
Teenus võimaldab lisada eesmärgile ChatGPT poolt genereeritud ühelauselise eesmärgi kirjelduse näidise, mis järgib SMART põhimõtteid. Kirjelduse näidis luuakse eesmärgiga seotud väljakutsete kirjelduste põhjal.
Seotud andmeobjektid:
Seotud Jira taskid
NSIL-705 - Getting issue details... STATUS
NSIL-903 - Getting issue details... STATUS
Eeltingimused ja kasutusõigused
- Kui tegemist on asutusepõhise eesmärgiga (Goal.goalScope = INSTITUTIONAL):
- Kasutajal on seos eesmärgi asutusega ja sama asutuse eesmärkide lisamise ja muutmise õigus.
- Goal.institution.id = Kasutaja poolt valitud rolliga seotud asutus
- Õigust reguleerib privileeg: HSILM_PLANNING_GOAL_MANAGE.
- Kasutajal on seos eesmärgi asutusega ja sama asutuse eesmärkide lisamise ja muutmise õigus.
- Kui tegemist on isikupõhise eesmärgiga (Goal.goalScope = INDIVIDUAL):
- Kasutaja on eesmärgi omanik ja tal on seos eesmärgi asutuse ja ametikohaga.
- Goal.personalCode = Päringu käivitanud kasutaja isikukood.
- Goal.institution.id = Kasutaja poolt valitud rolliga seotud asutus
- Goal.jobsite = Kasutaja poolt valitud rolliga seotud ametikoht
- Eraldi privileegi ei ole vaja.
- Kasutaja on eesmärgi omanik ja tal on seos eesmärgi asutuse ja ametikohaga.
- Või kasutaja on eesmärgi meeskonnas ja planeerimise meeskonna liikme rollil on eesmärkide lisamise ja muutmise õigus.
- Goal.goalScope = INSTITUTIONAL või INDIVIDUAL
- Goal.teamMembers.id = GoalTeamMember.id, mille personalCode = Päringu käivitanud kasutaja isikukood
- Õigust reguleerib privileeg: HSILM_PLANNING_GOAL_MANAGE.
Planeerimise mooduli kasutusrollide ja õiguste kohta saab täpsemalt infot leida lehelt Kasutusõigused ja rollid.
Sisendid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Vaikeväärtus, valideerimine | Kirjeldus, täiendav info |
|---|---|---|---|---|
goalId | 1 | String |
| Eesmärgi unikaalne identifikaator, mille jaoks saadakse ChatGPT mudelilt kirjelduse soovitus. |
Väljundid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Kirjeldus, täiendav info |
|---|---|---|---|
Samad mis teenusel PM: API: Goal: POST /planning-api/goals#V%C3%A4ljundid. | |||
Tegevused
- Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
- Kui kasutajal õigust pole, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
- Süsteem kontrollib, kas andmed vastavad nõuetele.
- Kui andmed ei vasta nõuetele, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
- Süsteem kontrollib, kas sisendis esitatud eesmärk (goalId) eksisteerib ja kas päringu käivitanud kasutajal on õigus selle andmeid hallata.
- Kontroll toimub vastavalt üldreeglites kirjeldatud loogikale.
- Kui eesmärki ei leita või see ei vasta üldreeglitele, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
- Süsteem kontrollib, kas eesmärgil puudub AI poolt pakutud kirjeldus ja kas sellega on seotud vähemalt üks väljakutse.
- Süsteem kontrollib, kas Objektid#Goal objekt, mille id = sisendis esitatud goalId ja archived = false, vastab järgmistele tingimustele:
- aiDescription = NULL
- assessmentChallengeIds nimekirjas on vähemalt üks id
- Kui tingimused ei ole täidetud, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
- Süsteem kontrollib, kas Objektid#Goal objekt, mille id = sisendis esitatud goalId ja archived = false, vastab järgmistele tingimustele:
- Süsteem otsib eesmärgiga seotud väljakutsete kirjeldused.
- Süsteem otsib Objektid#AssessmentChallenge objekte, mille:
- id = Goal.assessmentChallengeIds, kus id = sisendis esitatud goalId
- elements.code = "CHALLENGE"
- elements.textAreaValue != NULL
- Süsteem otsib Objektid#AssessmentChallenge objekte, mille:
- Süsteem saadab OpenAI API kaudu päringu ChatGPT mudelile eesmärgi soovituse saamiseks, edastades leitud väljakutsete kirjeldused (AssessmentChallenge.elements.textAreaValue).
- OpenAI käsk
- Kui päring ebaõnnestub, lõpetatakse päringu töötlemine ja tagastatakse OpenAI veakood.
- OpenAI käsk
- Süsteem lisab eesmärgile ChatGPT soovitatud kirjelduse.
- Süsteem uuendab Objektid#Goal objekti andmeid:
- aiDescription = OpenAI API päringust saadud eesmärgi kirjelduse soovitus
- audit = audit (muutmine)
- Süsteem uuendab Objektid#Goal objekti andmeid:
- Süsteem tagastab muudetud andmed.