/**
 * This file was auto-generated by Fern from our API Definition.
 */
import * as TwelvelabsApi from "../../../../index";
/**
 * @example
 *     {
 *         knowledgeStoreId: "ks_019ebcf4-7e08-7201-b69c-69e0c1e6ae56",
 *         input: [{
 *                 type: "message",
 *                 role: "user",
 *                 content: "Give me the highlight."
 *             }]
 *     }
 */
export interface ResponsesCreateRequest {
    /** The unique identifier of the knowledge store to reason over. */
    knowledgeStoreId: string;
    /** Provides context to Jockey for this request. Uses [Open Responses input item](https://www.openresponses.org/reference#input-items) conventions. */
    input: TwelvelabsApi.ResponseInputItem[];
    /**
     * The session identifier for a multi-turn conversation. Pass the session identifier
     * returned from a previous response to continue that conversation. Omit to start
     * a new session.
     *
     * When provided, the `knowledge_store_id` field must match the knowledge store the session
     * was originally created against, or the request returns `400`.
     */
    sessionId?: string;
    /** Additional guidance for Jockey, acting as a per-request system prompt. */
    instructions?: string;
    /**
     * Additional items to include in the response's `output` array. By default, the `output` array contains only Jockey's final reply.
     *
     * **Values**:
     * - `intermediate_outputs`: Also includes the steps Jockey took to produce the reply.
     */
    include?: TwelvelabsApi.ResponsesCreateRequestIncludeItem[];
    /**
     * Restricts the request to specific knowledge store items or item collections. The restriction is applied at the prompt level; the knowledge store does not block access to other items. Treat it as a strong preference, not a hard access boundary. Omit to run against every item.
     *
     * Selections persist in the session context, and selections sent on later turns are added to that context. You can reference selections from earlier turns in natural language without repeating their `{{sel:N}}` tokens.
     */
    selections?: TwelvelabsApi.ResponseSelection[];
    text?: TwelvelabsApi.TextParam;
}