Platform For AI:Java SDK

API

説明

PredictClient(HttpConfig httpConfig)

• PredictClient インスタンスを作成します。

• パラメーター： httpConfig は HttpConfig クラスのインスタンスです。

void setToken(String token)

• HTTP リクエストの認証トークンを設定します。

• パラメーター： token はサービスアクセス用の認証トークンです。

void setModelName(String modelName)

• オンライン予測サービスのモデル名を設定します。

• パラメーター： modelName は使用するモデルの名前です。

void setEndpoint(String endpoint)

• リクエスト先サービスのホストとポートを "host:port" 形式で設定します。

• パラメーター： endpoint は "host:port" 形式のサービスエンドポイントのアドレスです。

void setDirectEndpoint(String endpoint)

• VPC 専用接続でサービスにアクセスするためのエンドポイントを設定します。

• パラメーター： endpoint はサービスエンドポイントのアドレスです。

void setRequestPath(String requestPath)

• サーバーサイドのコードで定義されているリクエストパスを設定します。

• パラメーター： requestPath はサーバーサイドのリクエストパスです。例： client.setRequestPath("/custom_path")

void setRetryCount(int retryCount)

• リクエスト失敗時のリトライ回数を設定します。

• パラメーター： retryCount はリトライ回数です。

void setRetryConditions(EnumSet retryConditions)

• リクエストのリトライ条件を設定します。このメソッドは setRetryCount メソッドと併用できます。デフォルトでは、すべてのリクエストエラーがリトライされます。このメソッドを使用すると、特定のエラー発生時のみリトライするように指定できます。

• パラメーター： retryConditions は、1 つ以上のリトライ条件を含む EnumSet です。サポートされる条件は次のとおりです：

  • RetryCondition.CONNECTION_FAILED ： 接続の失敗

  • RetryCondition.CONNECTION_TIMEOUT ： 接続のタイムアウト

  • RetryCondition.READ_TIMEOUT ： レスポンス読み取りのタイムアウト

  • RetryCondition.RESPONSE_5XX ： サーバーからの 5xx ステータスコード

  • RetryCondition.RESPONSE_4XX ： サーバーからの 4xx ステータスコード

• 例：

  client.setRetryConditions(
      EnumSet.of(
          RetryCondition.READ_TIMEOUT,    // 読み取りタイムアウト時にリトライ
          RetryCondition.RESPONSE_5XX     // 5xx エラーコード時にリトライ
      )
  );

  この例では、タイムアウトが発生した場合、またはサーバーが 5xx のステータスコードを返した場合にのみ、リクエストをリトライするよう指定しています。

void setContentType(String contentType)

• HTTP リクエストの Content-Type を設定します。デフォルト値は "application/octet-stream" です。

• パラメーター： contentType は送信するデータストリームのコンテンツタイプです。

void setUrl(String url)

カスタムのリクエスト URL を設定します。

void setCompressor(Compressor compressor)

• リクエストデータの圧縮方法を設定します。

• パラメーター： compressor は圧縮方法です。サポートされる値は、Compressor.Gzip および Compressor.Zlib です。

• 詳細については、「Request Data Compression Example」をご参照ください。

void addExtraHeaders(Map<String, String> extraHeaders)

• リクエストにカスタムの HTTP ヘッダーを追加します。

• パラメーター： extraHeaders は追加する HTTP ヘッダーの Map<String, String> です。

PredictClient createChildClient(String token, String endpoint, String modelName)

• 親クライアントのスレッドプールを共有する子クライアントを作成して返します。これは、マルチスレッド予測に役立ちます。

• パラメーター：

  • token ： サービスの認証トークン。

  • endpoint ： サービスのエンドポイント。

  • modelName ： モデルの名前。

TFResponse predict(TFRequest runRequest)

• オンライン予測サービスに TensorFlow リクエストを送信し、結果を TFResponse オブジェクトとして返します。

• パラメーター： runRequest は TFRequest のインスタンスです。

String predict(String requestContent)

• オンライン予測サービスに文字列ベースのリクエストを送信し、結果を文字列として返します。

• パラメーター： requestContent は文字列形式のリクエスト内容です。

byte[] predict(byte[] requestContent)

• オンライン予測サービスにバイト配列のリクエストを送信し、結果をバイト配列として返します。

• パラメーター： requestContent はバイト配列形式のリクエスト内容です。

API

説明

void setIoThreadNum(int ioThreadNum)

• HTTP リクエストの I/O スレッド数を設定します。デフォルトは 2 です。

• パラメーター： ioThreadNum は I/O スレッド数です。

void setReadTimeout(int readTimeout)

• 接続の確立後、サーバーからデータパケットを受信するまで待機する最大時間です。デフォルト値は 5000 (5 秒) です。

• パラメーター： readTimeout はミリ秒単位の読み取りタイムアウトです。

void setRequestTimeout(int requestTimeout)

• 送信から完全なレスポンスの受信まで、リクエストに許可される合計時間です。デフォルト値は 5000 (5 秒) です。

• パラメーター： requestTimeout はミリ秒単位のリクエストタイムアウトです。

void setConnectTimeout(int connectTimeout)

• 接続の確立時に待機する最大時間です。デフォルト値は 5000 (5 秒) です。

• パラメーター： connectTimeout はミリ秒単位の接続タイムアウトです。

void setMaxConnectionCount(int maxConnectionCount)

• コネクションプール内の最大接続総数を設定します。デフォルトは 1000 です。

• パラメーター： maxConnectionCount は最大接続数です。

void setMaxConnectionPerRoute(int maxConnectionPerRoute)

• ルートごとの最大接続数を設定します。デフォルトは 1000 です。

• パラメーター： maxConnectionPerRoute は各ルートの最大接続数です。

void setKeepAlive(boolean keepAlive)

• HTTP サービスの keep-alive を設定します。

• パラメーター： keepAlive は、接続で keep-alive メカニズムを有効にするかどうかを指定します。デフォルト値は true です。

int getErrorCode()

直近の API 呼び出しのステータスコードを返します。

String getErrorMessage()

直近の API 呼び出しのステータスメッセージを返します。

API

説明

void setSignatureName(String value)

• モデルが TensorFlow SavedModel フォーマットの場合、リクエスト対象のモデルの SignatureDef の名前を指定します。

• パラメーター：リクエスト対象のモデルの SignatureDef の名前。

void addFetch(String value)

• モデルからフェッチする出力テンソルを指定します。

• パラメーター：value は、フェッチする出力テンソルのエイリアスです。

void addFeed(String inputName, TFDataType dataType, long[]shape, ?[]content)

• リクエストに入力テンソルを追加します。

• パラメーター：

  • inputName：入力テンソルのエイリアス。

  • dataType：入力テンソルのデータ型。

  • shape：入力テンソルの形状。

  • content：テンソルの内容。フラット化された 1 次元配列として提供されます。配列内の要素の型は dataType に依存します。

    入力テンソルの DataType が DT_FLOAT、DT_COMPLEX64、DT_BFLOAT16、または DT_HALF の場合、content 内の要素の型は浮動小数点です。DataType が DT_COMPLEX64 の場合、content 内の隣接する 2 つの浮動小数点要素は、それぞれ複素数の実部と虚部を表します。

    入力テンソルの DataType が DT_DOUBLE または DT_COMPLEX128 の場合、content 内の要素は DOUBLE 型です。DataType が DT_COMPLEX128 の場合、content 内の隣接する 2 つの DOUBLE 要素は、それぞれ複素数の実部と虚部を表します。

    入力テンソルの DataType が DT_INT32、DT_UINT8、DT_INT16、DT_INT8、DT_QINT8、DT_QUINT8、DT_QINT32、DT_QINT16、DT_QUINT16、または DT_UINT16 の場合、content 内の要素の型は INT です。

    入力テンソルの DataType が DT_INT64 の場合、content 内の要素の型は LONG です。

    入力テンソルの DataType が DT_STRING の場合、content 内の要素の型は文字列です。

    入力テンソルの DataType が DT_BOOL の場合、content 内の要素の型はブール値です。

API

説明

List<Long> getTensorShape(String outputName)

• 指定された出力テンソルの形状を取得します。

• パラメーター： outputName は、出力テンソルのエイリアスです。

• 戻り値： テンソルの形状を表す長整数のリスト。

List<Float> getFloatVals(String outputName)

• 出力テンソルのデータ型が DT_FLOAT、DT_COMPLEX64、DT_BFLOAT16、または DT_HALF の場合、指定された出力テンソルのデータを取得します。

• パラメーター： outputName は、出力テンソルのエイリアスです。

• 戻り値： モデルの TensorData 出力をフラット化したリスト。

List<Double> getDoubleVals(String outputName)

• 出力テンソルのデータ型が DT_DOUBLE または DT_COMPLEX128 の場合、指定された出力テンソルのデータを取得します。

• パラメーター： outputName は、出力テンソルのエイリアスです。

• 戻り値： モデルの TensorData 出力をフラット化したリスト。

List<Integer> getIntVals(String outputName)

• 出力テンソルのデータ型が DT_INT32、DT_UINT8、DT_INT16、DT_INT8、DT_QINT8、DT_QUINT8、DT_QINT32、DT_QINT16、DT_QUINT16、または DT_UINT16 の場合、指定された出力テンソルのデータを取得します。

• パラメーター： outputName は、出力テンソルのエイリアスです。

• 戻り値： モデルの TensorData 出力をフラット化したリスト。

List<String> getStringVals(String outputName)

• 出力テンソルのデータ型が DT_STRING の場合、そのテンソルのデータを取得します。

• パラメーター： outputName は、出力テンソルのエイリアスです。

• 戻り値： モデルの TensorData 出力をフラット化したリスト。

List<Long> getInt64Vals(String outputName)

• 出力テンソルのデータ型が DT_INT64 の場合、指定された出力テンソルのデータを取得します。

• パラメーター： outputName は、出力テンソルのエイリアスです。

• 戻り値： モデルの TensorData 出力をフラット化したリスト。

List<Boolean> getBoolVals(String outputName)

• 出力テンソルのデータ型が DT_BOOL の場合、指定された出力テンソルのデータを取得します。

• パラメーター： outputName は、出力テンソルのエイリアスです。

• 戻り値： モデルの TensorData 出力をフラット化したリスト。

API

説明

QueueClient(String endpoint, String queueName, String token, HttpConfig httpConfig, QueueUser user)

• QueueClient インスタンスを構築します。

• パラメーター：

  • endpoint：キューサービスのエンドポイントアドレス。

  • queueName：キューの名前。

  • token：サービスアクセス用のトークン。

  • httpConfig：HTTP リクエスト設定。

  • user：ユーザー設定。UserId (デフォルトはランダムな UUID) と GroupName (デフォルトは eas) を指定します。

JSONObject attributes()

• キューサービスの詳細な属性を取得します。

• 戻り値：キュー情報を含む JSONObject。次のフィールドが含まれます。

  • meta.maxPayloadBytes：単一のデータ項目に許可される最大サイズ (バイト単位)。

  • meta.name：キュー名。

  • stream.approxMaxLength：キューが格納できる項目の概算最大数。

  • stream.firstEntry：キュー内の最初の項目のインデックス。

  • stream.lastEntry：キュー内の最後の項目のインデックス。

  • stream.length：キュー内の現在の項目数。

Pair<Long, String> put(byte[] data, long priority, Map<String, String> tags)

• データ項目をキューに書き込みます。

• パラメーター：

  • data：書き込むデータ。バイト配列として指定します。

  • priority：データの優先度。高優先度の場合は 1、通常の優先度の場合は 0 (デフォルト)。

  • tags：カスタムのキーと値のタグのマップ。

• 戻り値：新しいデータ項目の index と request ID を含む Pair<Long, String>。

DataFrame[] get(long index, long length, long timeout, boolean autoDelete, Map<String, String> tags)

• キューからデータ項目を取得します。

• パラメーター：

  • index：データを取得する開始インデックス。最新のデータを読み取るには -1 を使用します。

  • length：取得するデータ項目の数。

  • timeout：タイムアウト期間 (秒単位)。

  • autoDelete：true の場合、取得後にデータがキューから自動的に削除されます。

  • tags：RequestID などのカスタムのキーと値のタグのマップ。

• 戻り値：DataFrame オブジェクトの配列。

void truncate(Long index)

• 指定された index より小さいインデックスを持つキュー内のすべてのデータ項目を削除します。

String delete(Long index)

• キューから特定のデータ項目を削除します。

• パラメーター：index は、削除するデータ項目のインデックスです。

• 戻り値：削除が成功した場合は "OK"。

JSONObject search(long index)

• キュー内の特定のデータ項目のステータスを照会します。

• パラメーター：index は、照会するデータ項目のインデックスです。

• 戻り値：次の情報を含むキューイング情報の JSONObject。

  • ConsumerId：項目を処理しているインスタンスの ID。

  • IsPending：項目が処理中の場合は true、キューで待機中の場合は false。

    • True は、項目が処理中であることを意味します。

    • False は、項目がキューで待機中であることを意味します。

  • WaitCount：キュー内で先行する項目の数。これは IsPending が false の場合にのみ有効です。IsPending が true の場合、この値は 0 です。

  レスポンスの例：

  • サービスが {'ConsumerId': 'eas.****', 'IsPending': False, 'WaitCount':2} を返す場合、リクエストがキューイングされていることを示します。

  • ログに no data in stream と表示され、{} が返される場合、データがキューに見つからなかったことを示します。これは、データがサーバー側で正常に処理され、結果が返されたか、index パラメーターが正しく設定されていない可能性があります。ご確認ください。

WebSocketWatcher watch(long index, long window, boolean indexOnly, boolean autoCommit, Map<String, String> tags)

• キューサービスをサブスクライブして、利用可能になったデータ項目を受信します。

• パラメーター：

  • index：開始インデックス。保留中のすべてのデータを無視して最新の項目から開始するには -1 を使用します。

  • window：送信ウィンドウのサイズ (未コミットの項目の最大数)。未コミットの項目数がこのウィンドウサイズに達すると、サービスは送信を一時停止します。

  • indexOnly：true の場合、返される DataFrame オブジェクトにはインデックスとタグのみが含まれ、データペイロードは含まれません。これにより帯域幅を節約できます。

  • autoCommit：true の場合、項目は受信時に自動的にコミットされ、commit() 呼び出しは不要です。autoCommit が true に設定されている場合、window パラメーターは無視されます。

  • tags：サブスクリプションリクエスト用のカスタムパラメーターのマップ。

• 戻り値：サブスクライブしたデータを受信するための WebSocketWatcher オブジェクト。使用方法の詳細については、「キューサービスの例」をご参照ください。

String commit(Long index) またはString commit(Long[] index)

• 1 つ以上のデータ項目が消費済みであることを通知し、それらをキューから削除します。

• 戻り値：コミットが成功した場合は "OK"。

void end(boolean force)

キューサービスへの接続を閉じます。

API

説明

byte[] getData()

• データペイロードを取得します。

• 戻り値： バイト配列形式のデータ。

long getIndex()

• データ項目のインデックスを取得します。

• 戻り値： long 型のデータインデックス。

Map<String, String> getTags()

• データ項目に関連付けられたタグを取得します。

• 戻り値： タグを表す Map<String, String> オブジェクト。このマップから、キー "requestId" を使用してリクエスト ID を取得できます。例： df.getTags().get("requestId")。