import {z} from 'zod' export type CreateApiNlInteractArgs = {Version: string, body: {sessionID: string, userPrompt: string}}; export type CreateApiNlInteractOptions = {baseUrl?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const canAdd = z.boolean(); export const prompt = z.string(); export const knownAnswers = z.array(z.unknown()); export const question = z.object({subject: z.string().optional(), object: z.string().optional(), objectType: z.string().optional(), objectMetadata: z.record(z.string(), z.unknown()).optional(), dataType: z.string().optional(), relationship: z.string().optional(), type: z.string().optional(), plural: z.boolean().optional(), allowCF: z.boolean().optional(), allowUnknown: z.boolean().optional(), canAdd: canAdd.optional(), prompt: prompt.optional(), knownAnswers: knownAnswers.optional(), concepts: z.array(z.object({conceptType: z.string().optional(), name: z.string().optional(), type: z.string().optional(), value: z.string().optional(), invalidResponse: z.boolean().optional()})).optional()}); export const nLError = z.object({code: z.number().int().optional(), message: z.string().optional(), suggestedChatResponse: z.string().optional(), statusCode: z.string().optional()}); export const nLMetadata = z.object({querySubmittedAt: z.string().optional(), languageEngineResponseTime: z.number().int().optional(), llmTokens: z.object({completionTokens: z.number().int().optional(), promptTokens: z.number().int().optional(), totalTokens: z.number().int().optional()}).optional(), apiVersion: z.string().optional(), endpoint: z.string().optional(), sessionID: z.string().optional()}); export const subject = z.string(); export const relationship = z.string(); export const object = z.union([z.string(), z.number(), z.boolean()]); export const certainty = z.number().gte(1).lte(100); export const createApiNlInteractResponse = z.object({responseType: z.enum(["question", "result", "error"]), query: z.object({subject: z.string(), relationship: z.string(), object: z.string().optional()}).optional(), questions: z.array(question).optional(), results: z.array(z.object({Certainty: z.number().int().optional(), FactID: z.string().optional(), Object: z.string().optional(), ObjectMetadata: z.object({}).optional(), ObjectValue: z.string().optional(), Relationship: z.string().optional(), Subject: z.string().optional(), SubjectMetadata: z.object({}).optional(), SubjectValue: z.string().optional()})).optional(), error: nLError.optional(), metadata: nLMetadata.optional(), facts: z.object({injected: z.array(z.object({subject: subject.optional(), relationship: relationship.optional(), object: object.optional(), certainty: certainty.optional()})).optional(), invalid: z.array(z.object({subject: subject.optional(), relationship: relationship.optional(), object: object.optional(), certainty: certainty.optional()})).optional(), unmatched: z.array(z.string()).optional()}).optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Interact (BETA) - natural language injection, queries and question responses * * POST /nl/interact */ export const createApiNlInteract = async (args: CreateApiNlInteractArgs, options?: CreateApiNlInteractOptions) => { const {baseUrl = "https://api.rainbird.ai", fetch: fetchFn = fetch, apiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (args.Version != null) headers.set("Version", String(args.Version)) if (apiKey !== undefined) headers.set("X-API-Key", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/nl/interact${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(createApiNlInteractResponse, await res.json()) };