SDK イントロダクション - QAIP Docs

主な機能

現在は6つの主要な機能を提供しています。

/completions: チャット形式で質問に答えます。
/search: ドキュメントを文章やキーワードで検索します。
/contents/{id}: コンテンツIDを指定してドキュメントの内容を取得します。
/extract: 指定したドキュメントから特定の情報を抽出します。
/tags: 登録したドキュメントのタグ一覧を取得します。
/tag-source-groups: ソースグループにタグをつけたり、タグを削除したりします。ソースグループとは、1つのジョブで取り込んだファイル群です。

インストール

QAIPのAPIを呼び出すためにSDKをインストールします：

pip install qaip

サンプルスクリプト

from qaip import Qaip
client = Qaip()

result = client.completion(
    messages=[{"role": "user", "content": "QAIPの主な機能について教えてください"}],
    citation=True,
)

for choice in result.choices:
    print(f"Assistant: {choice.message.content}")
    if choice.citations:
        print("\n引用元:")
        for i, citation in enumerate(choice.citations):
            print(f"- {i+1}: {citation.url}")

要求IDで問い合わせを追跡する

APIの応答header X-Request-IDで、そのHTTP要求のログを照合できます。問い合わせ時はこのIDをお知らせください。要求headerにもX-Request-IDを指定できます。受け入れる値は1〜128文字の ASCII英数字と.、_、-だけです。有効な値はそのまま返します。未指定・空文字・長さ超過・許可外の文字を含む値は、サーバー発行のIDに置き換えます。送信値を切り詰めたり、空白を取り除いて採用したりはしません。照合には応答headerのIDを使い、IDには機密情報を含めないでください。 Agent runのrequest_idは、初回作成時のIDを保持します。同じrunの再送や取得では、HTTP応答headerのIDと異なる場合があります。