questions

Create Question

Create a new question. A Question is allways associated with an insight and can not be created without an insight. Accepts Insight ID (ins_) and QuestionCreate Schema as input. The Question is processed and answered, the Answer is in the Question Schema the result. Steps while answering the question are stored in the QuestionSteps.

post/insight/{insight_id}/questions

Request

  • Base URL: https://api.overfit.de (the document declares no server; this is the origin it was published from)
  • URL: https://api.overfit.de/insight/{insight_id}/questions
  • Auth: one of:
    • OpenID Connect (https://auth.okns.de/realms/overfit-products/.well-known/openid-configuration)
    • API key in header X-API-Key

Path parameters

insight_idstring required

Request body

questionstring required
question_type'SUMMARY' | 'AGENT' | 'HYBRID' | 'FULL_TEXT' | 'FULL_TEXT_EXACT'

Example request

{
  "question": "What are the requirements for CE marking?",
  "question_type": "HYBRID"
}

Response

Successful Response

idstring required
questionstring required
time_createdstring date-time required
insight_idstring required
resultstring nullable required
question_type'SUMMARY' | 'AGENT' | 'HYBRID' | 'FULL_TEXT' | 'FULL_TEXT_EXACT' required
statusstring required
substring uuid required
lengthinteger required

Example response

{
  "source_snippets": [
    {
      "snippet": "The screwdriver is a tool, manual or powered, used for screwing (installing) and unscrewing (removing) screws. A typical simple screwdriver has a handle and a shaft.",
      "snippet_id": "789b936a-9e1b-41b5-b721-42d7308b858c",
      "source_id": "src_1EbVewEDVUf0oyAxzsi6LW"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.