Analytic Server コンテキスト

以下のように指定すると、Pyspark Python SparkContext インスタンスが返されます。

cxt.getSparkContext() : SparkContext

以下のように指定すると、Pyspark Python SQLContext インスタンスが返されます。

cxt.getSparkSQLContext() : SQLContext

以下のように指定すると、出力データ モデルを計算するためだけに操作が実行された場合は True が返されます。それ以外の場合は False が返されます。

cxt.isComputeDataModelOnly() : Boolean

以下のように指定すると、Spark 環境内でスクリプトが実行されている場合は True が返されます。現時点では、常に True が返されます。

cxt.isSparkExecution() : Boolean

以下のように指定すると、上流の一時ファイルから入力データが読み込まれ、pyspark.sql.DataFrame インスタンスが生成されます。

cxt.getSparkInputData() : DataFrame

以下のように指定すると、入力データ モデルから生成された pyspark.sql.StructType インスタンスが返されます。 入力データ モデルが存在しない場合は None が返されます。

cxt.getSparkInputSchema() : StructType

以下のように指定すると、Analytic Server コンテキストに出力データ フレームが直列化され、コンテキストが返されます。

cxt.setSparkOutputData( outDF) : AnalyticServerContext

パラメーター:

• outDF (DataFrame) : 出力データ フレームの値

例外:

• DataOutputNotSupported : このインターフェースが pyspark:buildmodel 関数で呼び出された場合にスローされます。
• ASContextException : 出力データ フレームが None の場合にスローされます。
• InconsistentOutputDataModel : 対象となる両方のオブジェクトに共通するフィールド名とストレージ タイプの情報が矛盾している場合にスローされます。

以下のように指定すると、outSchema StructType インスタンスがデータ モデルに変換され、そのデータ モデルが Analytic Server コンテキストに直列化され、コンテキストが返されます。

cxt.setSparkOutputSchema(outSchema) : AnalyticServerContext

パラメーター:

• outSchema(StructType) : 出力 StructType オブジェクト

例外:

• ASContextException : 出力スキーマ インスタンスが None の場合にスローされます。
• InconsistentOutputDataModel : 対象となる両方のオブジェクトに共通するフィールド名とストレージ タイプの情報が矛盾している場合にスローされます。

以下のように指定すると、モデルを作成するための出力情報の場所が Analytic Server コンテキストに保管され、コンテキストが返されます。

cxt.setModelContentFromPath(key, path, mimetype=None) : AnalyticServerContext

この場合のパスは、生成される cxt.createTemporaryFolder() API を使用するディレクトリのパスにすることができます (このディレクトリ内のすべてのものがモデル コンテンツとしてパッケージ化されている場合)。

パラメーター:

• key (string) : キーの文字列値
• path (string) : モデル作成用の出力の場所の文字列パス
• mimetype (string, optional) : コンテンツの MIME タイプ

例外:

• ModelOutputNotSupported : この API が pyspark:buildmodel 関数から呼び出されなかった場合にスローされます。
• KeyError : キー属性が None の場合や、文字列が空の場合にスローされます。

以下のように指定すると、モデル作成用コンテンツ、メタデータ、その他の属性が Analytic Server コンテキストに格納され、コンテキストが返されます。

cxt.setModelContentFromString(key, value, mimetype=None) : AnalyticServerContext

パラメーター:

• key (string) : キーの文字列値
• value (string) : モデル メタデータの文字列値
• mimetype (string, optional) : コンテンツの MIME タイプ

例外:

• ModelOutputNotSupported : この API が pyspark:buildmodel 関数から呼び出されなかった場合にスローされます。
• KeyError : キー属性が None の場合や、文字列が空の場合にスローされます。

以下のように指定すると、Analytic Server が管理する一時フォルダの場所が返されます。この一時フォルダを使用して、モデルのコンテンツを保管することができます。

cxt.createTemporaryFolder() : string

例外:

• ModelOutputNotSupported : この API が pyspark:buildmodel 関数から呼び出されなかった場合にスローされます。

以下のように指定すると、入力キーに一致するモデルの場所が返されます。

cxt.getModelContentToPath(key) : string

パラメーター:

• key (string) : キーの文字列値

例外:

• ModelInputNotSupported : この API が pyspark:applymodel 関数から呼び出されなかった場合にスローされます。
• KeyError : キー属性が None の場合や、文字列が空の場合にスローされます。
• IncompatibleModelContentType : モデルのコンテンツ タイプがコンテナではない場合にスローされます。

以下のように指定すると、入力キーに一致するモデルのコンテンツ、モデルのメタデータ、その他のモデル属性が返されます。

cxt.getModelContentToString(key) : string

パラメーター:

• key (string) : キーの文字列値

例外:

• ModelInputNotSupported : この API が pyspark:applymodel 関数から呼び出されなかった場合にスローされます。
• KeyError : キー属性が None の場合、文字列が空の場合、またはキーが存在しない場合にスローされます。
• IncompatibleModelContentType : モデルのコンテンツ タイプが矛盾している場合にスローされます。

以下のように指定すると、入力キーに割り当てられている MIME タイプが返されます。指定されたコンテンツに MIME タイプが含まれていない場合は、None が返されます。

cxt.getModelContentMimeType(key) : string

パラメーター:

• key (string) : キーの文字列値

例外:

• ModelInputNotSupported : この API が pyspark:applymodel 関数から呼び出されなかった場合にスローされます。
• KeyError : キー属性が None の場合、文字列が空の場合、またはキーが存在しない場合にスローされます。