Quickstart
はじめに
本記事では、OuterportのPython SDKを使用して、OuterportのAPIを呼び出す方法を説明します。
インストール
OuterportのPython SDKはPyPI(Python Package Index)からインストールできます。
クライアントの初期化
OuterportのPython SDKを使用するにaは、まずOuterportのAPIキーを取得する必要があります。
現時点ではOuterport APIはまだInvite Onlyとなっています。APIキーをリクエストするにはこちらからお問い合わせください。
APIキーを取得したら、次のようにクライアントを初期化します。
自己環境でOuterport APIを使用する場合
自己環境でホスティングされたOuterport APIを使用する場合は、base_url
をホスティングされたAPIのURLに設定します。
基本的な使い方
ドキュメントのアップロード
OuterportのPython SDKを使用して、ドキュメントをアップロードする方法を説明します。
client.documents.create
メソッドは、Document
オブジェクトを返します。
Outerport Python SDKは、基本的に「リソース」を作ると、オブジェクトを返します。リターンされるオブジェクトはクライアントと繋がっているので、reload()
メソッドを呼び出すことで最新のデータを取得したり、delete()
メソッドを呼び出すことで削除することができます。
ドキュメントに対して質問をする
OuterportのPython SDKを使用して、ドキュメントに対して質問をする方法を説明します。
client.questions.create
メソッドがリターンされると、質問の答えがquestion.final_answer
に格納されます。
question.final_answer
の他にも、質問を答える為の「プラニング」と「リサーチ」の過程がquestion.plan
とquestion.evidences
に格納されます。例えば、question.evidences
は以下のような結果が得られます。
ドキュメントの検索
関連性の高そうなドキュメントをクエリから検索する事も可能です。
client.documents.search
メソッドは、Document
オブジェクトのリストを返します。
タグやフォルダーを指定して検索する事も可能です。