Per-session analysis result, signals, gap events, and linked clusters

curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/knowledge-gaps/sessions/{session_id}/analysis \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api-sandbox.featherhq.com/v1/knowledge-gaps/sessions/{session_id}/analysis"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api-sandbox.featherhq.com/v1/knowledge-gaps/sessions/{session_id}/analysis', 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-sandbox.featherhq.com/v1/knowledge-gaps/sessions/{session_id}/analysis",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.featherhq.com/v1/knowledge-gaps/sessions/{session_id}/analysis"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-sandbox.featherhq.com/v1/knowledge-gaps/sessions/{session_id}/analysis")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.featherhq.com/v1/knowledge-gaps/sessions/{session_id}/analysis")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "knowledge_gap_analysis_outcome": "<string>",
  "job": {
    "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "attempts": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "current_stage": "<string>",
    "skip_reason": "<string>",
    "error_message": "<string>",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "failed_at": "2023-11-07T05:31:56Z"
  },
  "result": {
    "deep_analysis_required": true,
    "decision_source": "<string>",
    "decision_reason": "<string>",
    "knowledge_gap_detected": true,
    "analysis_confidence": 123,
    "candidate_count": 123,
    "total_gap_events": 123,
    "deep_analysis_reasons": [
      {}
    ],
    "unresolved_candidates": [
      {}
    ],
    "classified_gaps": [
      {}
    ],
    "retrieval_validation_results": [
      {}
    ]
  },
  "gap_events": [
    {
      "gap_event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "candidate_id": "<string>",
      "canonical_question": "<string>",
      "effective_gap_type": "<string>",
      "original_gap_type": "<string>",
      "severity": "<string>",
      "confidence": 123,
      "corrected_gap_type": "<string>",
      "completion_impact": "<string>",
      "validation_confidence": 123,
      "product_area": "<string>",
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "claims": [
        {}
      ],
      "retrieved_doc_ids": [
        "<string>"
      ],
      "cited_doc_ids": [
        "<string>"
      ],
      "implicated_doc_ids": [
        "<string>"
      ]
    }
  ],
  "linked_clusters": [
    {
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "<string>",
      "status": "<string>",
      "priority": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}