Generate LLM completion

Python

import os
from qaip import Qaip

client = Qaip(
    api_key=os.environ.get("QAIP_API_KEY"),  # This is the default and can be omitted
)
response = client.completion(
    messages=[{
        "content": "content",
        "role": "system",
    }],
)
print(response.assistant_message_id)

curl --request POST \
  --url https://developer.qaip.com/api/v1/completions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "messages": [
    {
      "content": "<string>"
    }
  ],
  "stream": false,
  "citation": true,
  "grounding": false,
  "tags": [
    "<string>"
  ],
  "tag_ids": [
    "<string>"
  ],
  "tag_filter_logic": "OR",
  "source_types": [],
  "file_types": [],
  "date_from": 1735639201,
  "date_to": 1735639201,
  "domains": [
    "<string>"
  ],
  "metadata": {
    "logic": "OR",
    "filters": [
      {
        "key": "<string>",
        "operator": "eq",
        "val": "<unknown>",
        "min": "<unknown>",
        "max": "<unknown>"
      }
    ],
    "groups": "<array>"
  },
  "source_metadata": {
    "logic": "OR",
    "filters": [
      {
        "key": "<string>",
        "operator": "eq",
        "val": "<unknown>",
        "min": "<unknown>",
        "max": "<unknown>"
      }
    ],
    "groups": "<array>"
  },
  "chunk_metadata": {
    "logic": "OR",
    "filters": [
      {
        "key": "<string>",
        "operator": "eq",
        "val": "<unknown>",
        "min": "<unknown>",
        "max": "<unknown>"
      }
    ],
    "groups": "<array>"
  },
  "use_postfilter": false,
  "limit": 10,
  "authz_policy": "external-chatbot",
  "principal_id": "user-123",
  "conversation_id": "550e8400-e29b-41d4-a716-446655440000",
  "parent_message_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "regenerate": false,
  "truncation": "auto"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messages: [{content: '<string>'}],
    stream: false,
    citation: true,
    grounding: false,
    tags: ['<string>'],
    tag_ids: ['<string>'],
    tag_filter_logic: 'OR',
    source_types: [],
    file_types: [],
    date_from: 1735639201,
    date_to: 1735639201,
    domains: ['<string>'],
    metadata: {
      logic: 'OR',
      filters: [
        {
          key: '<string>',
          operator: 'eq',
          val: '<unknown>',
          min: '<unknown>',
          max: '<unknown>'
        }
      ],
      groups: '<array>'
    },
    source_metadata: {
      logic: 'OR',
      filters: [
        {
          key: '<string>',
          operator: 'eq',
          val: '<unknown>',
          min: '<unknown>',
          max: '<unknown>'
        }
      ],
      groups: '<array>'
    },
    chunk_metadata: {
      logic: 'OR',
      filters: [
        {
          key: '<string>',
          operator: 'eq',
          val: '<unknown>',
          min: '<unknown>',
          max: '<unknown>'
        }
      ],
      groups: '<array>'
    },
    use_postfilter: false,
    limit: 10,
    authz_policy: 'external-chatbot',
    principal_id: 'user-123',
    conversation_id: '550e8400-e29b-41d4-a716-446655440000',
    parent_message_id: 'f47ac10b-58cc-4372-a567-0e02b2c3d479',
    regenerate: false,
    truncation: 'auto'
  })
};

fetch('https://developer.qaip.com/api/v1/completions', 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://developer.qaip.com/api/v1/completions",
  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([
    'messages' => [
        [
                'content' => '<string>'
        ]
    ],
    'stream' => false,
    'citation' => true,
    'grounding' => false,
    'tags' => [
        '<string>'
    ],
    'tag_ids' => [
        '<string>'
    ],
    'tag_filter_logic' => 'OR',
    'source_types' => [
        
    ],
    'file_types' => [
        
    ],
    'date_from' => 1735639201,
    'date_to' => 1735639201,
    'domains' => [
        '<string>'
    ],
    'metadata' => [
        'logic' => 'OR',
        'filters' => [
                [
                                'key' => '<string>',
                                'operator' => 'eq',
                                'val' => '<unknown>',
                                'min' => '<unknown>',
                                'max' => '<unknown>'
                ]
        ],
        'groups' => '<array>'
    ],
    'source_metadata' => [
        'logic' => 'OR',
        'filters' => [
                [
                                'key' => '<string>',
                                'operator' => 'eq',
                                'val' => '<unknown>',
                                'min' => '<unknown>',
                                'max' => '<unknown>'
                ]
        ],
        'groups' => '<array>'
    ],
    'chunk_metadata' => [
        'logic' => 'OR',
        'filters' => [
                [
                                'key' => '<string>',
                                'operator' => 'eq',
                                'val' => '<unknown>',
                                'min' => '<unknown>',
                                'max' => '<unknown>'
                ]
        ],
        'groups' => '<array>'
    ],
    'use_postfilter' => false,
    'limit' => 10,
    'authz_policy' => 'external-chatbot',
    'principal_id' => 'user-123',
    'conversation_id' => '550e8400-e29b-41d4-a716-446655440000',
    'parent_message_id' => 'f47ac10b-58cc-4372-a567-0e02b2c3d479',
    'regenerate' => false,
    'truncation' => 'auto'
  ]),
  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://developer.qaip.com/api/v1/completions"

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ],\n  \"stream\": false,\n  \"citation\": true,\n  \"grounding\": false,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"tag_ids\": [\n    \"<string>\"\n  ],\n  \"tag_filter_logic\": \"OR\",\n  \"source_types\": [],\n  \"file_types\": [],\n  \"date_from\": 1735639201,\n  \"date_to\": 1735639201,\n  \"domains\": [\n    \"<string>\"\n  ],\n  \"metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"source_metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"chunk_metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"use_postfilter\": false,\n  \"limit\": 10,\n  \"authz_policy\": \"external-chatbot\",\n  \"principal_id\": \"user-123\",\n  \"conversation_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"parent_message_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n  \"regenerate\": false,\n  \"truncation\": \"auto\"\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://developer.qaip.com/api/v1/completions")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ],\n  \"stream\": false,\n  \"citation\": true,\n  \"grounding\": false,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"tag_ids\": [\n    \"<string>\"\n  ],\n  \"tag_filter_logic\": \"OR\",\n  \"source_types\": [],\n  \"file_types\": [],\n  \"date_from\": 1735639201,\n  \"date_to\": 1735639201,\n  \"domains\": [\n    \"<string>\"\n  ],\n  \"metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"source_metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"chunk_metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"use_postfilter\": false,\n  \"limit\": 10,\n  \"authz_policy\": \"external-chatbot\",\n  \"principal_id\": \"user-123\",\n  \"conversation_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"parent_message_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n  \"regenerate\": false,\n  \"truncation\": \"auto\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developer.qaip.com/api/v1/completions")

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  \"messages\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ],\n  \"stream\": false,\n  \"citation\": true,\n  \"grounding\": false,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"tag_ids\": [\n    \"<string>\"\n  ],\n  \"tag_filter_logic\": \"OR\",\n  \"source_types\": [],\n  \"file_types\": [],\n  \"date_from\": 1735639201,\n  \"date_to\": 1735639201,\n  \"domains\": [\n    \"<string>\"\n  ],\n  \"metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"source_metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"chunk_metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"use_postfilter\": false,\n  \"limit\": 10,\n  \"authz_policy\": \"external-chatbot\",\n  \"principal_id\": \"user-123\",\n  \"conversation_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"parent_message_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n  \"regenerate\": false,\n  \"truncation\": \"auto\"\n}"

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

{
  "created": 1677649420,
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! How can I help you today?"
      },
      "finish_reason": "stop",
      "citations": [
        {
          "id": "<string>",
          "text": "<string>",
          "url": "<string>",
          "title": "<string>",
          "timestamp": 123,
          "page_number": 0,
          "source_id": "<string>",
          "keywords": [
            "<string>"
          ]
        }
      ],
      "web_citations": [
        {
          "url": "<string>",
          "title": "<string>"
        }
      ],
      "search_suggestion": "<string>",
      "web_search_queries": [
        "<string>"
      ]
    }
  ],
  "conversation_id": "550e8400-e29b-41d4-a716-446655440000",
  "user_message_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "assistant_message_id": "9b2e6f1a-3c4d-4e5f-8a9b-0c1d2e3f4a5b"
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

POST

completions

Python

import os
from qaip import Qaip

client = Qaip(
    api_key=os.environ.get("QAIP_API_KEY"),  # This is the default and can be omitted
)
response = client.completion(
    messages=[{
        "content": "content",
        "role": "system",
    }],
)
print(response.assistant_message_id)

curl --request POST \
  --url https://developer.qaip.com/api/v1/completions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "messages": [
    {
      "content": "<string>"
    }
  ],
  "stream": false,
  "citation": true,
  "grounding": false,
  "tags": [
    "<string>"
  ],
  "tag_ids": [
    "<string>"
  ],
  "tag_filter_logic": "OR",
  "source_types": [],
  "file_types": [],
  "date_from": 1735639201,
  "date_to": 1735639201,
  "domains": [
    "<string>"
  ],
  "metadata": {
    "logic": "OR",
    "filters": [
      {
        "key": "<string>",
        "operator": "eq",
        "val": "<unknown>",
        "min": "<unknown>",
        "max": "<unknown>"
      }
    ],
    "groups": "<array>"
  },
  "source_metadata": {
    "logic": "OR",
    "filters": [
      {
        "key": "<string>",
        "operator": "eq",
        "val": "<unknown>",
        "min": "<unknown>",
        "max": "<unknown>"
      }
    ],
    "groups": "<array>"
  },
  "chunk_metadata": {
    "logic": "OR",
    "filters": [
      {
        "key": "<string>",
        "operator": "eq",
        "val": "<unknown>",
        "min": "<unknown>",
        "max": "<unknown>"
      }
    ],
    "groups": "<array>"
  },
  "use_postfilter": false,
  "limit": 10,
  "authz_policy": "external-chatbot",
  "principal_id": "user-123",
  "conversation_id": "550e8400-e29b-41d4-a716-446655440000",
  "parent_message_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "regenerate": false,
  "truncation": "auto"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messages: [{content: '<string>'}],
    stream: false,
    citation: true,
    grounding: false,
    tags: ['<string>'],
    tag_ids: ['<string>'],
    tag_filter_logic: 'OR',
    source_types: [],
    file_types: [],
    date_from: 1735639201,
    date_to: 1735639201,
    domains: ['<string>'],
    metadata: {
      logic: 'OR',
      filters: [
        {
          key: '<string>',
          operator: 'eq',
          val: '<unknown>',
          min: '<unknown>',
          max: '<unknown>'
        }
      ],
      groups: '<array>'
    },
    source_metadata: {
      logic: 'OR',
      filters: [
        {
          key: '<string>',
          operator: 'eq',
          val: '<unknown>',
          min: '<unknown>',
          max: '<unknown>'
        }
      ],
      groups: '<array>'
    },
    chunk_metadata: {
      logic: 'OR',
      filters: [
        {
          key: '<string>',
          operator: 'eq',
          val: '<unknown>',
          min: '<unknown>',
          max: '<unknown>'
        }
      ],
      groups: '<array>'
    },
    use_postfilter: false,
    limit: 10,
    authz_policy: 'external-chatbot',
    principal_id: 'user-123',
    conversation_id: '550e8400-e29b-41d4-a716-446655440000',
    parent_message_id: 'f47ac10b-58cc-4372-a567-0e02b2c3d479',
    regenerate: false,
    truncation: 'auto'
  })
};

fetch('https://developer.qaip.com/api/v1/completions', 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://developer.qaip.com/api/v1/completions",
  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([
    'messages' => [
        [
                'content' => '<string>'
        ]
    ],
    'stream' => false,
    'citation' => true,
    'grounding' => false,
    'tags' => [
        '<string>'
    ],
    'tag_ids' => [
        '<string>'
    ],
    'tag_filter_logic' => 'OR',
    'source_types' => [
        
    ],
    'file_types' => [
        
    ],
    'date_from' => 1735639201,
    'date_to' => 1735639201,
    'domains' => [
        '<string>'
    ],
    'metadata' => [
        'logic' => 'OR',
        'filters' => [
                [
                                'key' => '<string>',
                                'operator' => 'eq',
                                'val' => '<unknown>',
                                'min' => '<unknown>',
                                'max' => '<unknown>'
                ]
        ],
        'groups' => '<array>'
    ],
    'source_metadata' => [
        'logic' => 'OR',
        'filters' => [
                [
                                'key' => '<string>',
                                'operator' => 'eq',
                                'val' => '<unknown>',
                                'min' => '<unknown>',
                                'max' => '<unknown>'
                ]
        ],
        'groups' => '<array>'
    ],
    'chunk_metadata' => [
        'logic' => 'OR',
        'filters' => [
                [
                                'key' => '<string>',
                                'operator' => 'eq',
                                'val' => '<unknown>',
                                'min' => '<unknown>',
                                'max' => '<unknown>'
                ]
        ],
        'groups' => '<array>'
    ],
    'use_postfilter' => false,
    'limit' => 10,
    'authz_policy' => 'external-chatbot',
    'principal_id' => 'user-123',
    'conversation_id' => '550e8400-e29b-41d4-a716-446655440000',
    'parent_message_id' => 'f47ac10b-58cc-4372-a567-0e02b2c3d479',
    'regenerate' => false,
    'truncation' => 'auto'
  ]),
  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://developer.qaip.com/api/v1/completions"

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ],\n  \"stream\": false,\n  \"citation\": true,\n  \"grounding\": false,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"tag_ids\": [\n    \"<string>\"\n  ],\n  \"tag_filter_logic\": \"OR\",\n  \"source_types\": [],\n  \"file_types\": [],\n  \"date_from\": 1735639201,\n  \"date_to\": 1735639201,\n  \"domains\": [\n    \"<string>\"\n  ],\n  \"metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"source_metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"chunk_metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"use_postfilter\": false,\n  \"limit\": 10,\n  \"authz_policy\": \"external-chatbot\",\n  \"principal_id\": \"user-123\",\n  \"conversation_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"parent_message_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n  \"regenerate\": false,\n  \"truncation\": \"auto\"\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://developer.qaip.com/api/v1/completions")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ],\n  \"stream\": false,\n  \"citation\": true,\n  \"grounding\": false,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"tag_ids\": [\n    \"<string>\"\n  ],\n  \"tag_filter_logic\": \"OR\",\n  \"source_types\": [],\n  \"file_types\": [],\n  \"date_from\": 1735639201,\n  \"date_to\": 1735639201,\n  \"domains\": [\n    \"<string>\"\n  ],\n  \"metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"source_metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"chunk_metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"use_postfilter\": false,\n  \"limit\": 10,\n  \"authz_policy\": \"external-chatbot\",\n  \"principal_id\": \"user-123\",\n  \"conversation_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"parent_message_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n  \"regenerate\": false,\n  \"truncation\": \"auto\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developer.qaip.com/api/v1/completions")

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  \"messages\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ],\n  \"stream\": false,\n  \"citation\": true,\n  \"grounding\": false,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"tag_ids\": [\n    \"<string>\"\n  ],\n  \"tag_filter_logic\": \"OR\",\n  \"source_types\": [],\n  \"file_types\": [],\n  \"date_from\": 1735639201,\n  \"date_to\": 1735639201,\n  \"domains\": [\n    \"<string>\"\n  ],\n  \"metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"source_metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"chunk_metadata\": {\n    \"logic\": \"OR\",\n    \"filters\": [\n      {\n        \"key\": \"<string>\",\n        \"operator\": \"eq\",\n        \"val\": \"<unknown>\",\n        \"min\": \"<unknown>\",\n        \"max\": \"<unknown>\"\n      }\n    ],\n    \"groups\": \"<array>\"\n  },\n  \"use_postfilter\": false,\n  \"limit\": 10,\n  \"authz_policy\": \"external-chatbot\",\n  \"principal_id\": \"user-123\",\n  \"conversation_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"parent_message_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n  \"regenerate\": false,\n  \"truncation\": \"auto\"\n}"

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

{
  "created": 1677649420,
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! How can I help you today?"
      },
      "finish_reason": "stop",
      "citations": [
        {
          "id": "<string>",
          "text": "<string>",
          "url": "<string>",
          "title": "<string>",
          "timestamp": 123,
          "page_number": 0,
          "source_id": "<string>",
          "keywords": [
            "<string>"
          ]
        }
      ],
      "web_citations": [
        {
          "url": "<string>",
          "title": "<string>"
        }
      ],
      "search_suggestion": "<string>",
      "web_search_queries": [
        "<string>"
      ]
    }
  ],
  "conversation_id": "550e8400-e29b-41d4-a716-446655440000",
  "user_message_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "assistant_message_id": "9b2e6f1a-3c4d-4e5f-8a9b-0c1d2e3f4a5b"
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

Authorizations

x-api-key

string

header

required

API key for authentication

Body

application/json

messages

object[]

required

The messages to generate completion for

Show child attributes

stream

boolean

default:false

Whether to stream the response. If true, the response is sent as a stream using the 'text/plain' content type.

citation

boolean

default:true

Whether to include citations in the response

grounding

boolean

default:false

Whether to enable Gemini's Google Search grounding during answer generation. Only effective when the completion model is a Gemini model and the gemini_grounding feature is enabled on the server; otherwise this flag is ignored.

Response

Successful completion. If the 'stream' parameter is false, the response is returned as application/json. If the 'stream' parameter is true, the response is returned as a stream of plain text (text/plain).

created

integer

required

The Unix timestamp (in seconds) of when the completion was created

Example:

1677649420

choices

object[]

required

The completion choices generated by the model

Show child attributes

conversation_id

string | null

Target conversation id. For an existing conversation (conversation_id was supplied) it is always returned, even if this turn's answer was not persisted. For a new conversation it is null when nothing was persisted (e.g. no answer generated, or the history write failed).

Example:

"550e8400-e29b-41d4-a716-446655440000"

user_message_id

string | null

Id of the persisted user message node for this turn. Null when the turn was not persisted.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

assistant_message_id

string | null

Id of the persisted assistant message node (the new active leaf). Null when no assistant node was persisted.

Example:

"9b2e6f1a-3c4d-4e5f-8a9b-0c1d2e3f4a5b"

SDK イントロダクション Get content

⌘I