cloudflare/resources/cloudforce-one/threat-signals/articles/skill-outputs.d.mts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../../core/resource.mjs";
import { APIPromise } from "../../../../core/api-promise.mjs";
import { RequestOptions } from "../../../../internal/request-options.mjs";
export declare class BaseSkillOutputs extends APIResource {
    static readonly _key: readonly ['cloudforceOne', 'threatSignals', 'articles', 'skillOutputs'];
    /**
     * Retrieves the stored output of a skill for a Threat Signals article.
     *
     * @example
     * ```ts
     * const skillOutput =
     *   await client.cloudforceOne.threatSignals.articles.skillOutputs.get(
     *     'skill_id',
     *     {
     *       account_id: 'account_id',
     *       article_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
     *     },
     *   );
     * ```
     */
    get(skillID: string, params: SkillOutputGetParams, options?: RequestOptions): APIPromise<SkillOutputGetResponse>;
}
export declare class SkillOutputs extends BaseSkillOutputs {
}
export interface SkillOutputGetResponse {
    article_id: string;
    custom_skill_version: string | null;
    /**
     * JSON-encoded output schema of the skill. Null when the skill no longer exists.
     */
    output_schema: string | null;
    skill_id: string;
    /**
     * Skill output. Parsed JSON when the stored output is valid JSON, otherwise the
     * raw string.
     */
    custom_output?: unknown;
}
export interface SkillOutputGetParams {
    account_id: string;
    article_id: string;
}
export declare namespace SkillOutputs {
    export { type SkillOutputGetResponse as SkillOutputGetResponse, type SkillOutputGetParams as SkillOutputGetParams, };
}
//# sourceMappingURL=skill-outputs.d.mts.map