Start a learning request in the background
curl --request POST \
--url https://api.getoneprofile.ai/agent-learnings/requests/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"kind": "thumbs_down",
"reason": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subject": {
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "table_cells",
"record_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
'import requests
url = "https://api.getoneprofile.ai/agent-learnings/requests/"
payload = {
"kind": "thumbs_down",
"reason": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subject": {
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "table_cells",
"record_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
kind: 'thumbs_down',
reason: '<string>',
request_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
subject: {
column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
kind: 'table_cells',
record_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
table_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
})
};
fetch('https://api.getoneprofile.ai/agent-learnings/requests/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getoneprofile.ai/agent-learnings/requests/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'kind' => 'thumbs_down',
'reason' => '<string>',
'request_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'subject' => [
'column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'kind' => 'table_cells',
'record_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'table_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getoneprofile.ai/agent-learnings/requests/"
payload := strings.NewReader("{\n \"kind\": \"thumbs_down\",\n \"reason\": \"<string>\",\n \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subject\": {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"kind\": \"table_cells\",\n \"record_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/agent-learnings/requests/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"kind\": \"thumbs_down\",\n \"reason\": \"<string>\",\n \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subject\": {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"kind\": \"table_cells\",\n \"record_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/agent-learnings/requests/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"kind\": \"thumbs_down\",\n \"reason\": \"<string>\",\n \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subject\": {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"kind\": \"table_cells\",\n \"record_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}"
response = http.request(request)
puts response.read_body{
"answer": {
"action": "added",
"agent_name": "<string>",
"event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"learning": {
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "table_cells",
"text": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"all_sequences": false,
"note": "<string>",
"note_surface": "table_cells",
"noted_at": "2023-11-07T05:31:56Z",
"notes": [
"<string>"
],
"repeats": 0,
"source_text": "<string>",
"step_key": "<string>",
"step_label": "<string>"
},
"previous_text": "<string>",
"redo": {
"detail": "<string>",
"state": "none"
},
"subject_key": "<string>",
"surface": "table_cells",
"more": [
{
"action": "added",
"learning_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"previous_text": "<string>",
"text": "<string>"
}
],
"proposal": {
"auto_rewrites": 123,
"changes": [
{
"find": "<string>",
"history": [
{
"find": "<string>",
"note": 123,
"replace_with": "<string>",
"text": "<string>"
}
],
"id": "<string>",
"kind": "add",
"note": 123,
"off": true,
"outcome": "applied",
"points": [
123
],
"question": "<string>",
"replace_with": "<string>",
"replaces_scope": "sequence",
"replaces_text": "<string>",
"saved_learning_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "sequence",
"step_label": "<string>",
"text": "<string>",
"words": 123
}
],
"learn_detail": "<string>",
"learn_state": "ok",
"moved_from_text": "<string>",
"points": [
{
"covered": true,
"goes_to": "rule",
"note": 123,
"number": 123,
"quote": "<string>",
"reason": "<string>",
"said": "<string>"
}
],
"replaces_scope": "sequence",
"replaces_text": "<string>",
"rev": 123,
"saved_learning_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "sequence",
"text": "<string>"
}
},
"error": {
"code": "reason_required",
"detail": "<string>",
"reason_error": "<string>",
"status": 123
},
"kind": "thumbs_down",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "running"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}agent-learnings
Start a learning request in the background
Do what one of four routes does without waiting for it, since the agent can take longer to learn than a request may stay open: kind thumbs_down gives a thumbs down (POST /agent-learnings/thumbs-downs/), hand_edit proposes a learning from an edit (POST /agent-learnings/hand-edits/), regenerate retries a proposed learning (POST /agent-learnings/thumbs-downs/{event_id}/regenerate/) and proposal_change changes one (PATCH /agent-learnings/thumbs-downs/{event_id}/proposal/), each with that route’s body. Answers at once with where it stands; ask GET /agent-learnings/requests/{request_id}/ every couple of seconds until it is done (with the answer a thumbs down gives) or failed (with the status and sentence that route would have refused with). The agent gets two minutes to learn. Sent again with the same request_id, it answers the same request; after it failed, it runs again. Only a signed-in person can, never an API key.
POST
/
agent-learnings
/
requests
/
Start a learning request in the background
curl --request POST \
--url https://api.getoneprofile.ai/agent-learnings/requests/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"kind": "thumbs_down",
"reason": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subject": {
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "table_cells",
"record_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
'import requests
url = "https://api.getoneprofile.ai/agent-learnings/requests/"
payload = {
"kind": "thumbs_down",
"reason": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subject": {
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "table_cells",
"record_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
kind: 'thumbs_down',
reason: '<string>',
request_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
subject: {
column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
kind: 'table_cells',
record_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
table_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
})
};
fetch('https://api.getoneprofile.ai/agent-learnings/requests/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getoneprofile.ai/agent-learnings/requests/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'kind' => 'thumbs_down',
'reason' => '<string>',
'request_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'subject' => [
'column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'kind' => 'table_cells',
'record_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'table_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getoneprofile.ai/agent-learnings/requests/"
payload := strings.NewReader("{\n \"kind\": \"thumbs_down\",\n \"reason\": \"<string>\",\n \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subject\": {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"kind\": \"table_cells\",\n \"record_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/agent-learnings/requests/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"kind\": \"thumbs_down\",\n \"reason\": \"<string>\",\n \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subject\": {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"kind\": \"table_cells\",\n \"record_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/agent-learnings/requests/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"kind\": \"thumbs_down\",\n \"reason\": \"<string>\",\n \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subject\": {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"kind\": \"table_cells\",\n \"record_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}"
response = http.request(request)
puts response.read_body{
"answer": {
"action": "added",
"agent_name": "<string>",
"event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"learning": {
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "table_cells",
"text": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"all_sequences": false,
"note": "<string>",
"note_surface": "table_cells",
"noted_at": "2023-11-07T05:31:56Z",
"notes": [
"<string>"
],
"repeats": 0,
"source_text": "<string>",
"step_key": "<string>",
"step_label": "<string>"
},
"previous_text": "<string>",
"redo": {
"detail": "<string>",
"state": "none"
},
"subject_key": "<string>",
"surface": "table_cells",
"more": [
{
"action": "added",
"learning_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"previous_text": "<string>",
"text": "<string>"
}
],
"proposal": {
"auto_rewrites": 123,
"changes": [
{
"find": "<string>",
"history": [
{
"find": "<string>",
"note": 123,
"replace_with": "<string>",
"text": "<string>"
}
],
"id": "<string>",
"kind": "add",
"note": 123,
"off": true,
"outcome": "applied",
"points": [
123
],
"question": "<string>",
"replace_with": "<string>",
"replaces_scope": "sequence",
"replaces_text": "<string>",
"saved_learning_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "sequence",
"step_label": "<string>",
"text": "<string>",
"words": 123
}
],
"learn_detail": "<string>",
"learn_state": "ok",
"moved_from_text": "<string>",
"points": [
{
"covered": true,
"goes_to": "rule",
"note": 123,
"number": 123,
"quote": "<string>",
"reason": "<string>",
"said": "<string>"
}
],
"replaces_scope": "sequence",
"replaces_text": "<string>",
"rev": 123,
"saved_learning_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "sequence",
"text": "<string>"
}
},
"error": {
"code": "reason_required",
"detail": "<string>",
"reason_error": "<string>",
"status": 123
},
"kind": "thumbs_down",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "running"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
APIKeyHeaderHTTPBearer
Body
application/json
- ThumbsDownRequestCreateSchema
- HandEditRequestCreateSchema
- RegenerateRequestCreateSchema
- ProposalChangeRequestCreateSchema
Needs work, a first or a further note on a feedback session, given in the background.
A thumbs down, as POST /agent-learnings/thumbs-downs/ takes it.
Allowed value:
"thumbs_down"What is wrong, in the person's words. Required.
Maximum string length:
1000The client's key for this thumbs down: sent again (a double click, a retry), it answers what the first one did and writes nothing.
Cells of one agent column.
- TableCellsSubjectSchema
- AgentPreviewSubjectSchema
- TaskSubjectSchema
- WritingPreviewSubjectSchema
- ReplyDraftSubjectSchema
- SentMessageSubjectSchema
- HandEditSubjectSchema
Show child attributes
Show child attributes
Response
Successful Response
A learning request given in the background, and where it stands.
Once done: what it did, as POST /agent-learnings/thumbs-downs/ answers; for a Retry or a change, the proposed learning it acted on, as it now stands. On a proposal from an edit, proposal is null when the words came back to the agent's and the learning proposed from an earlier edit was dismissed.
Show child attributes
Show child attributes
Once failed: why.
Show child attributes
Show child attributes
What it runs, as it was sent.
Available options:
thumbs_down, hand_edit, regenerate, proposal_change The key it was sent under, to ask again by.
running while the agent learns (ask again in a couple of seconds), then done with answer, or failed with error.
Available options:
running, done, failed Was this page helpful?