雅典娜类型脚本库

雅典娜TypeScript库从TypeScript提供对雅典娜API的方便访问.

目录

• 安装
• 参考文献
• 使用量
• 请求和答复类型
• 例外处理
• 二进制响应
• 高级
  • 其他信头
  • 其它查询字符串参数
  • 检索
  • 超时
  • 中止请求
  • 访问原始响应数据
  • 运行时间相容性
• 捐款

安装

npm i -s @athenaintel/sdk

参考文献

该图书馆的全部参考资料可供查阅 这里。 。 。 .

使用量

以下列方式证明和使用客户端:

import { AthenaIntelligenceClient } from "@athenaintel/sdk";

const client = new AthenaIntelligenceClient({ apiKey: "YOUR_API_KEY", sessionCredential: "YOUR_SESSION_CREDENTIAL" });
await client.aop.create({
    agentId: "research_agent",
    description: "Generates market research reports",
    icon: "ListTodo",
    parent_folder_id: "asset_folder_12345",
    prompt: "Generate a comprehensive market research report for [[ company ]]",
    section: "Research",
    title: "Market Research Report",
    workspace_id: "workspace_abc123"
});

请求和响应类型

SDK导出所有请求和响应类型为TypeScript接口. 只需用 以下命名空间:

import { AthenaIntelligence } from "@athenaintel/sdk";

const request: AthenaIntelligence.GetBatchStatusAopRequest = {
    ...
};

例外处理

当 API 返回一个非成功状态代码( 4xx 或 5xx 响应) 时, 以下错误的子类 将会被扔出.

import { AthenaIntelligenceError } from "@athenaintel/sdk";

try {
    await client.aop.create(...);
} catch (err) {
    if (err instanceof AthenaIntelligenceError) {
        console.log(err.statusCode);
        console.log(err.message);
        console.log(err.body);
        console.log(err.rawResponse);
    }
}

文件上传

您可以使用客户端上传文件 :

import { createReadStream } from "fs";
import { AthenaIntelligenceClient } from "@athenaintel/sdk";
import * as fs from "fs";

const client = new AthenaIntelligenceClient({ apiKey: "YOUR_API_KEY", sessionCredential: "YOUR_SESSION_CREDENTIAL" });
await client.assets.createFromFile({
    file: fs.createReadStream("/path/to/your/file")
});

客户端接受多种类型的文件上传参数:

• 流类型 : fs.ReadStream, (中文(简体) ), stream.Readable,以及 ReadableStream
• 缓冲类型 : Buffer, (中文(简体) ), Blob, (中文(简体) ), File, (中文(简体) ), ArrayBuffer, (中文(简体) ), ArrayBufferView,以及 Uint8Array

元数据

您可以在上传文件时配置元数据 :

const file: Uploadable.WithMetadata = {
    data: createReadStream("path/to/file"),
    filename: "my-file",       // optional
    contentType: "audio/mpeg", // optional
    contentLength: 1949,       // optional
};

或者,您可以从文件路径直接上传文件 :

const file : Uploadable.FromPath = {
    path: "path/to/file",
    filename: "my-file",        // optional
    contentType: "audio/mpeg",  // optional
    contentLength: 1949,        // optional
};

元数据用于设置 Content-Length, (中文(简体) ), Content-Type,以及 Content-Disposition 头. 如果不提供,客户端将尝试自动确定. 譬如说, fs.ReadStream 有一个 path 属性,SDK用于从文件系统取回文件大小而不将其装入内存.

二进制响应

您可以使用 BinaryResponse 类型,允许您选择如何消耗数据 :

const response = await client.assets.download(...);
const stream: ReadableStream<Uint8Array> = response.stream();
// const arrayBuffer: ArrayBuffer = await response.arrayBuffer();
// const blob: Blob = response.blob();
// const bytes: Uint8Array = response.bytes();
// You can only use the response body once, so you must choose one of the above methods.
// If you want to check if the response body has been used, you can use the following property.
const bodyUsed = response.bodyUsed;

倾斜

列表终点为相接点. SDK提供了一个传动器,这样你就可以简单地绕过这些项目:

import { AthenaIntelligenceClient } from "@athenaintel/sdk";

const client = new AthenaIntelligenceClient({ apiKey: "YOUR_API_KEY", sessionCredential: "YOUR_SESSION_CREDENTIAL" });
const pageableResponse = await client.meetings.list({
    limit: 50,
    offset: 0
});
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.meetings.list({
    limit: 50,
    offset: 0
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

高级

其他信头

如果您希望作为请求的一部分发送额外的信头,请使用 headers 请求选项.

const response = await client.aop.create(..., {
    headers: {
        'X-Custom-Header': 'custom value'
    }
});

其它查询字符串参数

如果您希望作为请求的一部分发送额外的查询字符串参数,请使用 queryParams 请求选项.

const response = await client.aop.create(..., {
    queryParams: {
        'customQueryParamKey': 'custom query param value'
    }
});

检索

SDK是用有指数回放的自动回放装置. 申请要等会再审 由于请求被认为可以重试,且重试的次数没有超过所配置的 重试限制( 默认: 2) .

当返回以下任一 HTTP 状态代码时, 请求被视为可重试 :

• 408 (简体中文) (超时)
• 429个 (太多请求)
• 第5XX条 (内部服务器出错)

使用 maxRetries 请求选项来配置此行为.

const response = await client.aop.create(..., {
    maxRetries: 0 // override maxRetries at the request level
});

超时

SDK默认为60第二次超时. 使用 timeoutInSeconds 选项来配置此行为.

const response = await client.aop.create(..., {
    timeoutInSeconds: 30 // override timeout to 30s
});

中止请求

SDK允许用户在任何时刻通过一个中止信号来中止请求.

const controller = new AbortController();
const response = await client.aop.create(..., {
    abortSignal: controller.signal
});
controller.abort(); // aborts the request

访问原始响应数据

SDK通过下列方式提供原始响应数据,包括信头: .withRawResponse() 方法. 这个 .withRawResponse() 方法返回给一个带有 data (单位:千美元) rawResponse 属性.

const { data, rawResponse } = await client.aop.create(...).withRawResponse();

console.log(data);
console.log(rawResponse.headers['X-My-Header']);

日志

SDK支持记录. 您可以通过通过一个 logging 对象对客户端选项.

import { AthenaIntelligenceClient, logging } from "@athenaintel/sdk";

const client = new AthenaIntelligenceClient({
    ...
    logging: {
        level: logging.LogLevel.Debug, // defaults to logging.LogLevel.Info
        logger: new logging.ConsoleLogger(), // defaults to ConsoleLogger
        silent: false, // defaults to true, set to false to enable logging
    }
});

这个 logging 对象可以具有以下属性:

• level: 要使用的日志级别 。 默认为 logging.LogLevel.Info。 。 。 .
• logger:要使用的伐木机. 默认为 a logging.ConsoleLogger。 。 。 .
• silent: 是否让伐木工安静. 默认为 true。 。 。 .

这个 level 属性可以是下列值之一:

• logging.LogLevel.Debug
• logging.LogLevel.Info
• logging.LogLevel.Warn
• logging.LogLevel.Error

要提供自定义日志, 您可以通过一个执行 logging.ILogger 接口.

import winston from 'winston';

const winstonLogger = winston.createLogger({...});

const logger: logging.ILogger = {
    debug: (msg, ...args) => winstonLogger.debug(msg, ...args),
    info: (msg, ...args) => winstonLogger.info(msg, ...args),
    warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
    error: (msg, ...args) => winstonLogger.error(msg, ...args),
};

import pino from 'pino';

const pinoLogger = pino({...});

const logger: logging.ILogger = {
  debug: (msg, ...args) => pinoLogger.debug(args, msg),
  info: (msg, ...args) => pinoLogger.info(args, msg),
  warn: (msg, ...args) => pinoLogger.warn(args, msg),
  error: (msg, ...args) => pinoLogger.error(args, msg),
};

运行时间相容性

SDK工作时间如下:

• 节点.js 18+
• 维塞尔
• 云花岗工人
• 德诺v1.25+
• 1.0+号舱
• 原生反应

自定义获取客户端

SDK为您提供了自定义 HTTP 客户端/ 获取功能的方法 。 如果你正在运行在一个 不支持的环境,这为您提供了一个打破玻璃并确保SDK工作的方法.

import { AthenaIntelligenceClient } from "@athenaintel/sdk";

const client = new AthenaIntelligenceClient({
    ...
    fetcher: // provide your implementation here
});

捐款

虽然我们重视对SDK的开源贡献,但这个库是程序生成的. 直接给这个图书馆增加的代码 得转到我们一代人的代码上, 否则,它们将被覆盖 在下一次产生的释放。 随便打开公关吧 是一个概念的证明, 但知道我们将无法 合并它作为一个。 我们建议开放 先和我们讨论一个问题!

另一方面,对 " README " 的贡献总是非常受欢迎的!