aardio 文档

web.rest.embeddings 库模块帮助文档

web.rest 成员列表 #

web.rest.embeddings #

AI 嵌入模型客户端

web.rest.embeddings() #

返回对象:webRestEmbeddingsObject

web.rest.embeddings(config) #

web.rest.aiChat(  
    proxy = proxy,  
    model = "model-id",  
    dimensions = 1024,  
    format = "float",  
    url = ""  
)/*创建嵌入模型客户端。参数说明:  
- url 字段指定接口网址,如果有"/v1"后缀需要显式指定 。  
- 可选用 dimensions 指定向量维度。  
- 可选用 format 指定返回格式(encoding_format)。   
- 可选用 proxy 字段指定代理服务器,代理格式: https://www.aardio.com/zh-cn/doc/library-guide/std/inet/proxy   
- 可选用 userAgent 字段指定用户代理。  
- 可选用 extraParameters, extraUrlParameters 字段指定附加参数表(table)*/

webRestEmbeddingsObject 成员列表 #

webRestEmbeddingsObject._http #

inet.http客户端,用于执行 http 请求

返回对象:inetHttpObject

webRestEmbeddingsObject.close() #

关闭对象释放资源

webRestEmbeddingsObject.config #

自定义的 API 配置表。
默认指向创建对象时指定的表参数。

webRestEmbeddingsObject.create(输入文本) #

调用嵌入模型创建向量。
参数 @1 可指定字符串或字符串数组。
成功返回向量信息数组,第 2 个返回值为原始 JSON 对象(data 字段为向量信息数组)。
出错则返回值 1 为 null,返回值 2 为错误信息。

webRestEmbeddingsObject.defaultHeaders #

替换所有请求默认添加的HTTP头
请求结束时不会清空此属性
该值可以是一个字符串,也可以是键值对组成的table对象

webRestEmbeddingsObject.extraParameters #

指定附加到所有请求参数中的默认参数
该值应当是一个表,请求参数指定表对象时或为null才会附加extraParameters

webRestEmbeddingsObject.extraUrlParameters #

指定附加到所有请求 URL 的默认参数。
该值可以是一个表或字符串。
表参数使用 inet.url.stringifyParameters 转换为字符串。
表中的值如果是函数则每次请求都调用该函数取值

webRestEmbeddingsObject.get(网址,参数表) #

使用该GET方法提交请求,获取资源
请求参数将会自动转换为URL附加参数,
请求参数可以指定表或字符串,如果是表请求前会转换为字符串
成功返回数据,失败返回空值,错误信息,错误代码

webRestEmbeddingsObject.lastRequestUrl #

获取最后一次请求的 URL。
允许的 beforeRequestHeaders 事件中修改此属性以改变请求地址。

webRestEmbeddingsObject.lastResponse() #

获取最后一次服务器返回的数据,流式调用时此函数返回值无意义。
如果控制台已打开或在开发环境中导入 console 库则在控制台输出数据
下载文件时该值为空

webRestEmbeddingsObject.lastResponseError() #

返回服务器最后一次返回的错误响应,并转换为错误对象。
与调用 API 时转换响应数据一样,支持相同的服务器响应格式 。
如果错误来自本地(lastStatusCode 属性为 null)则此函数返回 null 。
如果最后一次发生请求成功,则此函数返回 null 。

如果在参数 @1 中指定返回字段,且错误对象包含该字段则使用直接下标获取并返回字段值。
获取字段失败返回 null 而非抛出异常

webRestEmbeddingsObject.lastResponseObject() #

获取最后一次服务器返回的对象(已将响应文本解析为对象),
如果是 SSE 流式调用,返回最后一次接受的包含 token 计数的对象
请求失败,或者下载文件时此属性值为空。

webRestEmbeddingsObject.lastResponseString() #

获取最后一次服务器返回的原始数据,流式调用时此函数返回值无意义。
请求失败,或者下载文件时此属性值为空

webRestEmbeddingsObject.lastStatusCode #

获取最近一次请求返回的HTTP状态码
100 ~ 101 为信息提示
200 ~ 206 表示请求成功
300 ~ 305 表示重定向
400 ~ 415 表求客户端请求出错
500 ~ 505 表示服务端错误

webRestEmbeddingsObject.lastStatusMessage() #

获取最近返回的HTTP状态码文本描述
第二个返回值为状态码

webRestEmbeddingsObject.ok() #

最后一次请求是否成功
服务器应答并且状态码为2XX该函数返回真

webRestEmbeddingsObject.post(网址,参数表) #

使用该POST方法提交请求,新增或修改资源
请求参数可以指定表或字符串,如果是表请求前会转换为字符串
成功返回数据,失败返回空值,错误信息,错误代码

webRestEmbeddingsObject.referer #

引用页地址。
如果此属性指定了一个值,则每次请求都会使用该引用页。
如果不指定,每次请求都会自动设置上次请求的网址为引用页。
这个属性不像 inet.http 对象的 referer 属性那样每次请求结束都会清空。

webRestEmbeddingsObject.setHeaders #

设置所有请求默认添加的HTTP头

webRestEmbeddingsObject.setHeaders(headers) #

参数 @headers 必须指定一个表中,
用该表中的键值对更新 defaultHeaders 属性中的键值
如果 defaultHeaders 的原属性值不是一个表,则先清空该属性

webRestEmbeddingsObject.setTimeouts(连接超时,请求超时,接收超时) #

设置超时,以亳秒为单位(1秒为1000毫秒)。

Markdown 格式