Analytic Server 上下文

上下文提供了 Analytic Server 上下文接口支持,可以与 SPSS Analytic Server 进行交互。

AnalyticServerContext 对象

AnalyticServerContext 对象可设置上下文环境,该环境将提供多个接口以用于与 SPSS Analytic Server 进行交互。 想要构造此上下文实例的应用程序必须使用 spss.pyspark.runtime.getContext() 接口执行此操作,而不是直接实施接口。

返回 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 : 当不是从 pyspark:buildmodel 函数调用此 API 时
  • KeyError : 如果密钥属性为 None 或者字符串为空
将模型构建内容、元数据或其他属性存储到 Analytic Server 上下文并返回上下文:
cxt.setModelContentFromString(key, value, mimetype=None) : AnalyticServerContext
参数:
  • key (string) : 键字符串值
  • value (string) : 模型元数据字符串值
  • mimetype (string, optional) : 内容的 MIME 类型
异常:
  • ModelOutputNotSupported : 当不是从 pyspark:buildmodel 函数调用此 API 时
  • KeyError : 如果密钥属性为 None 或者字符串为空
返回 Analytic Server 管理的临时文件夹位置;这可用于存储模型内容:
cxt.createTemporaryFolder() : string
异常:
  • ModelOutputNotSupported : 当不是从 pyspark:buildmodel 函数调用此 API 时
返回匹配输入键的模型的位置:
cxt.getModelContentToPath(key) : string
参数:
  • key (string) : 键字符串值
异常:
  • ModelInputNotSupported : 当不是从 pyspark:applymodel 函数调用此 API 时
  • KeyError : 如果密钥属性为 None 或者字符串为空
  • IncompatibleModelContentType : 如果模型内容类型不是容器
返回匹配输入键的模型内容、模型的元数据或其他模型属性:
cxt.getModelContentToString(key) : string
参数:
  • key (string) : 键字符串值
异常:
  • ModelInputNotSupported : 当不是从 pyspark:applymodel 函数调用此 API 时
  • KeyError : 如果键属性为 None、字符串为空或者键不存在
  • IncompatibleModelContentType : 如果模型内容类型不一致
返回分配给输入键的 MIME 类型。 如果指定的内容无 MIME 类型,那么返回 None
cxt.getModelContentMimeType(key) : string
参数:
  • key (string) : 键字符串值
异常:
  • ModelInputNotSupported : 当不是从 pyspark:applymodel 函数调用此 API 时
  • KeyError : 如果键属性为 None、字符串为空或者键不存在