@maiyunnet/kebab 7.6.0 → 7.6.1

package/doc/sc/api/lib/ai/classes/Ai.md

@@ -0,0 +1,103 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ai](../index.md) / Ai
+
+# Class: Ai
+
+Defined in: [lib/ai.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L49)
+
+## Constructors
+
+### Constructor
+
+> **new Ai**(`ctrEtc`, `opt`): `Ai`
+
+Defined in: [lib/ai.ts:56](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L56)
+
+#### Parameters
+
+##### ctrEtc
+
+[`IConfigAi`](../../../index/interfaces/IConfigAi.md) | [`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+##### opt
+
+[`IOptions`](../interfaces/IOptions.md)
+
+#### Returns
+
+`Ai`
+
+## Properties
+
+### link
+
+> `readonly` **link**: `OpenAI`
+
+Defined in: [lib/ai.ts:52](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L52)
+
+openai 原生对象，建议只读
+
+## Methods
+
+### chat()
+
+创建对话
+
+#### Call Signature
+
+> **chat**(`body`): `Promise`\<`false` \| `APIPromise`\<`ChatCompletion`\>\>
+
+Defined in: [lib/ai.ts:111](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L111)
+
+创建非流式对话
+
+##### Parameters
+
+###### body
+
+`ChatCompletionCreateParamsNonStreaming`
+
+##### Returns
+
+`Promise`\<`false` \| `APIPromise`\<`ChatCompletion`\>\>
+
+#### Call Signature
+
+> **chat**(`body`): `Promise`\<`false` \| `APIPromise`\<`Stream`\<`ChatCompletionChunk`\>\>\>
+
+Defined in: [lib/ai.ts:115](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L115)
+
+创建流式对话
+
+##### Parameters
+
+###### body
+
+`ChatCompletionCreateParamsStreaming`
+
+##### Returns
+
+`Promise`\<`false` \| `APIPromise`\<`Stream`\<`ChatCompletionChunk`\>\>\>
+
+***
+
+### embedding()
+
+> **embedding**(`body`): `Promise`\<`false` \| `APIPromise`\<`CreateEmbeddingResponse`\>\>
+
+Defined in: [lib/ai.ts:135](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L135)
+
+创建向量
+
+#### Parameters
+
+##### body
+
+`EmbeddingCreateParams`
+
+#### Returns
+
+`Promise`\<`false` \| `APIPromise`\<`CreateEmbeddingResponse`\>\>

package/doc/sc/api/lib/ai/enumerations/ESERVICE.md

@@ -0,0 +1,61 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ai](../index.md) / ESERVICE
+
+# Enumeration: ESERVICE
+
+Defined in: [lib/ai.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L18)
+
+服务商定义
+
+## Enumeration Members
+
+### ALIAS
+
+> **ALIAS**: `1`
+
+Defined in: [lib/ai.ts:22](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L22)
+
+阿里国际区
+
+***
+
+### ALICN
+
+> **ALICN**: `0`
+
+Defined in: [lib/ai.ts:20](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L20)
+
+阿里中国大陆区
+
+***
+
+### AZURE
+
+> **AZURE**: `2`
+
+Defined in: [lib/ai.ts:24](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L24)
+
+微软 Azure
+
+***
+
+### AZURE2
+
+> **AZURE2**: `3`
+
+Defined in: [lib/ai.ts:26](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L26)
+
+微软 Azure 2
+
+***
+
+### AZURE3
+
+> **AZURE3**: `4`
+
+Defined in: [lib/ai.ts:28](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L28)
+
+微软 Azure 3

package/doc/sc/api/lib/ai/functions/get.md

@@ -0,0 +1,29 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ai](../index.md) / get
+
+# Function: get()
+
+> **get**(`ctrEtc`, `opt`): [`Ai`](../classes/Ai.md)
+
+Defined in: [lib/ai.ts:154](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L154)
+
+创建一个 AI 对象
+
+## Parameters
+
+### ctrEtc
+
+[`IConfigAi`](../../../index/interfaces/IConfigAi.md) | [`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+### opt
+
+[`IOptions`](../interfaces/IOptions.md)
+
+选项
+
+## Returns
+
+[`Ai`](../classes/Ai.md)

package/doc/sc/api/lib/ai/index.md

@@ -0,0 +1,23 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/ai
+
+# lib/ai
+
+## Enumerations
+
+- [ESERVICE](enumerations/ESERVICE.md)
+
+## Classes
+
+- [Ai](classes/Ai.md)
+
+## Interfaces
+
+- [IOptions](interfaces/IOptions.md)
+
+## Functions
+
+- [get](functions/get.md)

package/doc/sc/api/lib/ai/interfaces/IOptions.md

@@ -0,0 +1,65 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ai](../index.md) / IOptions
+
+# Interface: IOptions
+
+Defined in: [lib/ai.ts:32](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L32)
+
+选项
+
+## Properties
+
+### endpoint?
+
+> `optional` **endpoint**: `string`
+
+Defined in: [lib/ai.ts:36](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L36)
+
+接入点
+
+***
+
+### fetch()?
+
+> `optional` **fetch**: (`input`, `init?`) => `Promise`\<`Response`\>
+
+Defined in: [lib/ai.ts:40](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L40)
+
+自定义 fetch 函数
+
+#### Parameters
+
+##### input
+
+`string` | `Request` | `URL`
+
+##### init?
+
+`RequestInit`
+
+#### Returns
+
+`Promise`\<`Response`\>
+
+***
+
+### secretKey?
+
+> `optional` **secretKey**: `string`
+
+Defined in: [lib/ai.ts:38](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L38)
+
+密钥
+
+***
+
+### service
+
+> **service**: [`ESERVICE`](../enumerations/ESERVICE.md)
+
+Defined in: [lib/ai.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L34)
+
+服务商 -

package/doc/sc/api/lib/buffer/classes/Reader.md

@@ -0,0 +1,177 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/buffer](../index.md) / Reader
+
+# Class: Reader
+
+Defined in: [lib/buffer.ts:2](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L2)
+
+读对象
+
+## Constructors
+
+### Constructor
+
+> **new Reader**(`buffer`): `Reader`
+
+Defined in: [lib/buffer.ts:9](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L9)
+
+#### Parameters
+
+##### buffer
+
+`Buffer`
+
+#### Returns
+
+`Reader`
+
+## Methods
+
+### length()
+
+> **length**(): `number`
+
+Defined in: [lib/buffer.ts:83](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L83)
+
+获取完整的 buffer 长度
+
+#### Returns
+
+`number`
+
+***
+
+### readBCDString()
+
+> **readBCDString**(`length?`): `string`
+
+Defined in: [lib/buffer.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L49)
+
+读取一个 BCD 编码的字符串（每个字节表示两个数字）
+
+#### Parameters
+
+##### length?
+
+`number`
+
+#### Returns
+
+`string`
+
+***
+
+### readBuffer()
+
+> **readBuffer**(`length?`): `Buffer`
+
+Defined in: [lib/buffer.ts:77](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L77)
+
+读取 Buffer
+
+#### Parameters
+
+##### length?
+
+`number`
+
+#### Returns
+
+`Buffer`
+
+***
+
+### readString()
+
+> **readString**(`length?`, `encoding?`): `string`
+
+Defined in: [lib/buffer.ts:62](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L62)
+
+读取普通 string
+
+#### Parameters
+
+##### length?
+
+`number`
+
+##### encoding?
+
+`BufferEncoding` = `'utf8'`
+
+#### Returns
+
+`string`
+
+***
+
+### readUInt16BE()
+
+> **readUInt16BE**(): `number`
+
+Defined in: [lib/buffer.ts:21](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L21)
+
+读取一个无符号 16 位整数（大端模式），WORD
+
+#### Returns
+
+`number`
+
+***
+
+### readUInt16LE()
+
+> **readUInt16LE**(): `number`
+
+Defined in: [lib/buffer.ts:28](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L28)
+
+读取一个无符号 16 位整数（小端模式）
+
+#### Returns
+
+`number`
+
+***
+
+### readUInt32BE()
+
+> **readUInt32BE**(): `number`
+
+Defined in: [lib/buffer.ts:35](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L35)
+
+读取一个无符号 32 位整数（大端模式）, DWORD
+
+#### Returns
+
+`number`
+
+***
+
+### readUInt32LE()
+
+> **readUInt32LE**(): `number`
+
+Defined in: [lib/buffer.ts:42](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L42)
+
+读取一个无符号 32 位整数（小端模式）
+
+#### Returns
+
+`number`
+
+***
+
+### readUInt8()
+
+> **readUInt8**(): `number`
+
+Defined in: [lib/buffer.ts:14](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L14)
+
+读取一个无符号 8 位整数, BYTE
+
+#### Returns
+
+`number`

package/doc/sc/api/lib/buffer/classes/Writer.md

@@ -0,0 +1,147 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/buffer](../index.md) / Writer
+
+# Class: Writer
+
+Defined in: [lib/buffer.ts:90](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L90)
+
+写对象
+
+## Constructors
+
+### Constructor
+
+> **new Writer**(`size`): `Writer`
+
+Defined in: [lib/buffer.ts:97](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L97)
+
+#### Parameters
+
+##### size
+
+`number`
+
+#### Returns
+
+`Writer`
+
+## Methods
+
+### get()
+
+> **get**(): `Buffer`
+
+Defined in: [lib/buffer.ts:140](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L140)
+
+返回 Buffer 对象
+
+#### Returns
+
+`Buffer`
+
+***
+
+### writeBCDString()
+
+> **writeBCDString**(`value`): `void`
+
+Defined in: [lib/buffer.ts:120](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L120)
+
+[每字节 2 数字] 写入一个 BCD 编码的字符串（仅支持数字）
+
+#### Parameters
+
+##### value
+
+`string`
+
+#### Returns
+
+`void`
+
+***
+
+### writeString()
+
+> **writeString**(`value`, `encoding`): `number`
+
+Defined in: [lib/buffer.ts:130](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L130)
+
+写入普通字符串，返回写入的长度
+
+#### Parameters
+
+##### value
+
+`string`
+
+##### encoding
+
+`BufferEncoding` = `'utf8'`
+
+#### Returns
+
+`number`
+
+***
+
+### writeUInt16BE()
+
+> **writeUInt16BE**(`value`): `void`
+
+Defined in: [lib/buffer.ts:108](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L108)
+
+[2 字节] 写入一个无符号 16 位整数（大端模式）
+
+#### Parameters
+
+##### value
+
+`number`
+
+#### Returns
+
+`void`
+
+***
+
+### writeUInt32BE()
+
+> **writeUInt32BE**(`value`): `void`
+
+Defined in: [lib/buffer.ts:114](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L114)
+
+[4 字节] 写入一个无符号 32 位整数（大端模式）
+
+#### Parameters
+
+##### value
+
+`number`
+
+#### Returns
+
+`void`
+
+***
+
+### writeUInt8()
+
+> **writeUInt8**(`value`): `void`
+
+Defined in: [lib/buffer.ts:102](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L102)
+
+[1 字节] 写入一个无符号 8 位整数
+
+#### Parameters
+
+##### value
+
+`number`
+
+#### Returns
+
+`void`

package/doc/sc/api/lib/buffer/functions/getReader.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/buffer](../index.md) / getReader
+
+# Function: getReader()
+
+> **getReader**(`buffer`): [`Reader`](../classes/Reader.md)
+
+Defined in: [lib/buffer.ts:150](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L150)
+
+Buffer Reader 对象
+
+## Parameters
+
+### buffer
+
+`Buffer`
+
+要读取的 buffer
+
+## Returns
+
+[`Reader`](../classes/Reader.md)

package/doc/sc/api/lib/buffer/functions/getWriter.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/buffer](../index.md) / getWriter
+
+# Function: getWriter()
+
+> **getWriter**(`size`): [`Writer`](../classes/Writer.md)
+
+Defined in: [lib/buffer.ts:158](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L158)
+
+Buffer Writer 对象
+
+## Parameters
+
+### size
+
+`number`
+
+缓冲区大小
+
+## Returns
+
+[`Writer`](../classes/Writer.md)

package/doc/sc/api/lib/buffer/index.md

@@ -0,0 +1,17 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/buffer
+
+# lib/buffer
+
+## Classes
+
+- [Reader](classes/Reader.md)
+- [Writer](classes/Writer.md)
+
+## Functions
+
+- [getReader](functions/getReader.md)
+- [getWriter](functions/getWriter.md)