From f95617e6cd662b4c2b8a948e66aeedabe5216e20 Mon Sep 17 00:00:00 2001 From: ochk-docs-bot Date: Sat, 5 Sep 2026 02:02:00 +0000 Subject: [PATCH] docs(sdk): sync agent-openai@1.0.0 Auto-generated by oc-packages release workflow on tag agent-openai-v1.0.0. Source: https://github.com/orangecheck/oc-packages/tree/agent-openai-v1.0.0/agent-openai/src Co-Authored-By: ochk-docs-bot --- src/pages/sdk/agent-openai/README.mdx | 6 ---- .../functions/invokeWithStampAndPost.mdx | 34 ------------------ .../functions/postActionToFleet.mdx | 35 ------------------ .../agent-openai/interfaces/FleetClient.mdx | 23 ------------ .../InvokeWithStampAndPostInput.mdx | 36 ------------------- .../InvokeWithStampAndPostResult.mdx | 33 ----------------- .../interfaces/InvokeWithStampInput.mdx | 4 --- .../interfaces/InvokeWithStampResult.mdx | 4 --- .../interfaces/PostActionResult.mdx | 22 ------------ 9 files changed, 197 deletions(-) delete mode 100644 src/pages/sdk/agent-openai/functions/invokeWithStampAndPost.mdx delete mode 100644 src/pages/sdk/agent-openai/functions/postActionToFleet.mdx delete mode 100644 src/pages/sdk/agent-openai/interfaces/FleetClient.mdx delete mode 100644 src/pages/sdk/agent-openai/interfaces/InvokeWithStampAndPostInput.mdx delete mode 100644 src/pages/sdk/agent-openai/interfaces/InvokeWithStampAndPostResult.mdx delete mode 100644 src/pages/sdk/agent-openai/interfaces/PostActionResult.mdx diff --git a/src/pages/sdk/agent-openai/README.mdx b/src/pages/sdk/agent-openai/README.mdx index 8bf452b..3184ae5 100644 --- a/src/pages/sdk/agent-openai/README.mdx +++ b/src/pages/sdk/agent-openai/README.mdx @@ -11,13 +11,9 @@ export const metadata = { ## Interfaces -- [FleetClient](interfaces/FleetClient.mdx) -- [InvokeWithStampAndPostInput](interfaces/InvokeWithStampAndPostInput.mdx) -- [InvokeWithStampAndPostResult](interfaces/InvokeWithStampAndPostResult.mdx) - [InvokeWithStampInput](interfaces/InvokeWithStampInput.mdx) - [InvokeWithStampResult](interfaces/InvokeWithStampResult.mdx) - [OpenAiFunctionCall](interfaces/OpenAiFunctionCall.mdx) -- [PostActionResult](interfaces/PostActionResult.mdx) - [StampFunctionCallInput](interfaces/StampFunctionCallInput.mdx) ## Functions @@ -26,7 +22,5 @@ export const metadata = { - [functionCallActionId](functions/functionCallActionId.mdx) - [functionCallHash](functions/functionCallHash.mdx) - [invokeWithStamp](functions/invokeWithStamp.mdx) -- [invokeWithStampAndPost](functions/invokeWithStampAndPost.mdx) - [parseFunctionCall](functions/parseFunctionCall.mdx) -- [postActionToFleet](functions/postActionToFleet.mdx) - [stampFunctionCall](functions/stampFunctionCall.mdx) diff --git a/src/pages/sdk/agent-openai/functions/invokeWithStampAndPost.mdx b/src/pages/sdk/agent-openai/functions/invokeWithStampAndPost.mdx deleted file mode 100644 index e9f9699..0000000 --- a/src/pages/sdk/agent-openai/functions/invokeWithStampAndPost.mdx +++ /dev/null @@ -1,34 +0,0 @@ -export const metadata = { - title: "Function: invokeWithStampAndPost()", - description: "Auto-generated API reference for Function: invokeWithStampAndPost(). Source: TypeScript types in oc-packages.", -}; - -[**@orangecheck/agent-openai**](../README.mdx) - -*** - -[@orangecheck/agent-openai](../README.mdx) / invokeWithStampAndPost - -# Function: invokeWithStampAndPost() - -```ts -function invokeWithStampAndPost(input: InvokeWithStampAndPostInput): Promise>; -``` - -Defined in: [index.ts:278](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L278) - -## Type Parameters - -| Type Parameter | -| ------ | -| `T` | - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `input` | [`InvokeWithStampAndPostInput`](../interfaces/InvokeWithStampAndPostInput.mdx)\<`T`\> | - -## Returns - -`Promise`\<[`InvokeWithStampAndPostResult`](../interfaces/InvokeWithStampAndPostResult.mdx)\<`T`\>\> diff --git a/src/pages/sdk/agent-openai/functions/postActionToFleet.mdx b/src/pages/sdk/agent-openai/functions/postActionToFleet.mdx deleted file mode 100644 index 35cce7d..0000000 --- a/src/pages/sdk/agent-openai/functions/postActionToFleet.mdx +++ /dev/null @@ -1,35 +0,0 @@ -export const metadata = { - title: "Function: postActionToFleet()", - description: "Auto-generated API reference for Function: postActionToFleet(). Source: TypeScript types in oc-packages.", -}; - -[**@orangecheck/agent-openai**](../README.mdx) - -*** - -[@orangecheck/agent-openai](../README.mdx) / postActionToFleet - -# Function: postActionToFleet() - -```ts -function postActionToFleet(action: ActionEnvelope, client: FleetClient): Promise; -``` - -Defined in: [index.ts:228](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L228) - -POST a stamped action envelope to fleet.ochk.io/api/actions. The -fleet re-derives the action id, validates agent-must-match- -delegation, persists, fans out to Nostr (kind 30084), submits to -OC Stamp, and triggers any subscribed webhooks. Throws on non-2xx -with the server's reason string. - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `action` | `ActionEnvelope` | -| `client` | [`FleetClient`](../interfaces/FleetClient.mdx) | - -## Returns - -`Promise`\<[`PostActionResult`](../interfaces/PostActionResult.mdx)\> diff --git a/src/pages/sdk/agent-openai/interfaces/FleetClient.mdx b/src/pages/sdk/agent-openai/interfaces/FleetClient.mdx deleted file mode 100644 index 1356d73..0000000 --- a/src/pages/sdk/agent-openai/interfaces/FleetClient.mdx +++ /dev/null @@ -1,23 +0,0 @@ -export const metadata = { - title: "Interface: FleetClient", - description: "Auto-generated API reference for Interface: FleetClient. Source: TypeScript types in oc-packages.", -}; - -[**@orangecheck/agent-openai**](../README.mdx) - -*** - -[@orangecheck/agent-openai](../README.mdx) / FleetClient - -# Interface: FleetClient - -Defined in: [index.ts:204](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L204) - -## Properties - -| Property | Type | Description | Defined in | -| ------ | ------ | ------ | ------ | -| <a id="property-apitoken"></a> `apiToken` | `string` | Bearer token from /settings § 03 (`ock_`). | [index.ts:208](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L208) | -| <a id="property-baseurl"></a> `baseUrl?` | `string` | Defaults to https://fleet.ochk.io. | [index.ts:206](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L206) | -| <a id="property-fetch"></a> `fetch?` | (`input`: `RequestInfo` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> | Optional fetch override for runtimes that need it. | [index.ts:212](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L212) | -| <a id="property-projectid"></a> `projectId` | `string` | Project the action belongs to (proj_*). | [index.ts:210](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L210) | diff --git a/src/pages/sdk/agent-openai/interfaces/InvokeWithStampAndPostInput.mdx b/src/pages/sdk/agent-openai/interfaces/InvokeWithStampAndPostInput.mdx deleted file mode 100644 index a9a6aa9..0000000 --- a/src/pages/sdk/agent-openai/interfaces/InvokeWithStampAndPostInput.mdx +++ /dev/null @@ -1,36 +0,0 @@ -export const metadata = { - title: "Interface: InvokeWithStampAndPostInput", - description: "Auto-generated API reference for Interface: InvokeWithStampAndPostInput. Source: TypeScript types in oc-packages.", -}; - -[**@orangecheck/agent-openai**](../README.mdx) - -*** - -[@orangecheck/agent-openai](../README.mdx) / InvokeWithStampAndPostInput - -# Interface: InvokeWithStampAndPostInput\<T\> - -Defined in: [index.ts:268](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L268) - -## Extends - -- [`InvokeWithStampInput`](InvokeWithStampInput.mdx)\<`T`\> - -## Type Parameters - -| Type Parameter | -| ------ | -| `T` | - -## Properties - -| Property | Type | Description | Inherited from | Defined in | -| ------ | ------ | ------ | ------ | ------ | -| <a id="property-agent"></a> `agent` | `SignerRef` | - | [`InvokeWithStampInput`](InvokeWithStampInput.mdx).[`agent`](InvokeWithStampInput.mdx#property-agent) | [index.ts:144](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L144) | -| <a id="property-call"></a> `call` | `unknown` | Either a normalized `OpenAiFunctionCall` or a raw OpenAI tool_call / function_call object. | [`InvokeWithStampInput`](InvokeWithStampInput.mdx).[`call`](InvokeWithStampInput.mdx#property-call) | [index.ts:147](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L147) | -| <a id="property-delegation"></a> `delegation` | `DelegationEnvelope` | - | [`InvokeWithStampInput`](InvokeWithStampInput.mdx).[`delegation`](InvokeWithStampInput.mdx#property-delegation) | [index.ts:145](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L145) | -| <a id="property-execute"></a> `execute` | (`call`: [`OpenAiFunctionCall`](OpenAiFunctionCall.mdx)) => `Promise`\<`T`\> | Your handler. Receives the normalized OpenAiFunctionCall. | [`InvokeWithStampInput`](InvokeWithStampInput.mdx).[`execute`](InvokeWithStampInput.mdx#property-execute) | [index.ts:182](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L182) | -| <a id="property-fleet"></a> `fleet?` | [`FleetClient`](FleetClient.mdx) | Fleet credentials. If absent, behaves like invokeWithStamp. | - | [index.ts:270](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L270) | -| <a id="property-scopeexercised"></a> `scopeExercised?` | `string` | Defaults to `openai:function(name=)` — the tightest admissible sub-scope. | [`InvokeWithStampInput`](InvokeWithStampInput.mdx).[`scopeExercised`](InvokeWithStampInput.mdx#property-scopeexercised) | [index.ts:149](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L149) | -| <a id="property-signedat"></a> `signedAt?` | `Date` | - | [`InvokeWithStampInput`](InvokeWithStampInput.mdx).[`signedAt`](InvokeWithStampInput.mdx#property-signedat) | [index.ts:150](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L150) | diff --git a/src/pages/sdk/agent-openai/interfaces/InvokeWithStampAndPostResult.mdx b/src/pages/sdk/agent-openai/interfaces/InvokeWithStampAndPostResult.mdx deleted file mode 100644 index a18a37b..0000000 --- a/src/pages/sdk/agent-openai/interfaces/InvokeWithStampAndPostResult.mdx +++ /dev/null @@ -1,33 +0,0 @@ -export const metadata = { - title: "Interface: InvokeWithStampAndPostResult", - description: "Auto-generated API reference for Interface: InvokeWithStampAndPostResult. Source: TypeScript types in oc-packages.", -}; - -[**@orangecheck/agent-openai**](../README.mdx) - -*** - -[@orangecheck/agent-openai](../README.mdx) / InvokeWithStampAndPostResult - -# Interface: InvokeWithStampAndPostResult\<T\> - -Defined in: [index.ts:273](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L273) - -## Extends - -- [`InvokeWithStampResult`](InvokeWithStampResult.mdx)\<`T`\> - -## Type Parameters - -| Type Parameter | -| ------ | -| `T` | - -## Properties - -| Property | Type | Description | Inherited from | Defined in | -| ------ | ------ | ------ | ------ | ------ | -| <a id="property-action"></a> `action` | `ActionEnvelope` | - | [`InvokeWithStampResult`](InvokeWithStampResult.mdx).[`action`](InvokeWithStampResult.mdx#property-action) | [index.ts:187](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L187) | -| <a id="property-call"></a> `call` | [`OpenAiFunctionCall`](OpenAiFunctionCall.mdx) | - | [`InvokeWithStampResult`](InvokeWithStampResult.mdx).[`call`](InvokeWithStampResult.mdx#property-call) | [index.ts:188](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L188) | -| <a id="property-posted"></a> `posted` | [`PostActionResult`](PostActionResult.mdx) \| `null` | Set when fleet is configured AND the POST succeeded. | - | [index.ts:275](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L275) | -| <a id="property-result"></a> `result` | `T` | - | [`InvokeWithStampResult`](InvokeWithStampResult.mdx).[`result`](InvokeWithStampResult.mdx#property-result) | [index.ts:186](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L186) | diff --git a/src/pages/sdk/agent-openai/interfaces/InvokeWithStampInput.mdx b/src/pages/sdk/agent-openai/interfaces/InvokeWithStampInput.mdx index 0acce86..23e7e22 100644 --- a/src/pages/sdk/agent-openai/interfaces/InvokeWithStampInput.mdx +++ b/src/pages/sdk/agent-openai/interfaces/InvokeWithStampInput.mdx @@ -17,10 +17,6 @@ Defined in: [index.ts:180](https://github.com/orangecheck/oc-packages/blob/main/ - [`StampFunctionCallInput`](StampFunctionCallInput.mdx) -## Extended by - -- [`InvokeWithStampAndPostInput`](InvokeWithStampAndPostInput.mdx) - ## Type Parameters | Type Parameter | diff --git a/src/pages/sdk/agent-openai/interfaces/InvokeWithStampResult.mdx b/src/pages/sdk/agent-openai/interfaces/InvokeWithStampResult.mdx index 0de87a2..429e553 100644 --- a/src/pages/sdk/agent-openai/interfaces/InvokeWithStampResult.mdx +++ b/src/pages/sdk/agent-openai/interfaces/InvokeWithStampResult.mdx @@ -13,10 +13,6 @@ export const metadata = { Defined in: [index.ts:185](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L185) -## Extended by - -- [`InvokeWithStampAndPostResult`](InvokeWithStampAndPostResult.mdx) - ## Type Parameters | Type Parameter | diff --git a/src/pages/sdk/agent-openai/interfaces/PostActionResult.mdx b/src/pages/sdk/agent-openai/interfaces/PostActionResult.mdx deleted file mode 100644 index 0474268..0000000 --- a/src/pages/sdk/agent-openai/interfaces/PostActionResult.mdx +++ /dev/null @@ -1,22 +0,0 @@ -export const metadata = { - title: "Interface: PostActionResult", - description: "Auto-generated API reference for Interface: PostActionResult. Source: TypeScript types in oc-packages.", -}; - -[**@orangecheck/agent-openai**](../README.mdx) - -*** - -[@orangecheck/agent-openai](../README.mdx) / PostActionResult - -# Interface: PostActionResult - -Defined in: [index.ts:215](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L215) - -## Properties - -| Property | Type | Defined in | -| ------ | ------ | ------ | -| <a id="property-delegation_id"></a> `delegation_id` | `string` | [index.ts:218](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L218) | -| <a id="property-id"></a> `id` | `string` | [index.ts:216](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L216) | -| <a id="property-project_id"></a> `project_id` | `string` | [index.ts:217](https://github.com/orangecheck/oc-packages/blob/main/agent-openai/src/index.ts#L217) |