@azure/openai-assistants/types/src/rest/outputModels.d.ts

An isomorphic client library for Azure OpenAI Assistants.

/**
 * THIS IS AN AUTO-GENERATED FILE - DO NOT EDIT!
 *
 * Any changes you make here may be lost.
 *
 * If you need to make changes, please do so in the original source file, \{project-root\}/sources/custom
 */
/** The input definition information for a code interpreter tool as used to configure an assistant. */
export interface CodeInterpreterToolDefinitionOutput {
    /** The object type, which is always 'code_interpreter'. */
    type: "code_interpreter";
}
/** The input definition information for a retrieval tool as used to configure an assistant. */
export interface RetrievalToolDefinitionOutput {
    /** The object type, which is always 'retrieval'. */
    type: "retrieval";
}
/** The input definition information for a function tool as used to configure an assistant. */
export interface FunctionToolDefinitionOutput {
    /** The object type, which is always 'function'. */
    type: "function";
    /** The definition of the concrete function that the function tool should call. */
    function: FunctionDefinitionOutput;
}
/** The input definition information for a function. */
export interface FunctionDefinitionOutput {
    /** The name of the function to be called. */
    name: string;
    /** A description of what the function does, used by the model to choose when and how to call the function. */
    description: string;
    /** The parameters the functions accepts, described as a JSON Schema object. */
    parameters: any;
}
export interface TypeSpecRecordOutput extends Record<string, string> {
}
/** Represents an assistant that can call the model and use tools. */
export interface AssistantOutput {
    /** The identifier, which can be referenced in API endpoints. */
    id: string;
    /** The Unix timestamp, in seconds, representing when this object was created. */
    created_at: number;
    /** The name of the assistant. */
    name: string | null;
    /** The description of the assistant. */
    description: string | null;
    /** The ID of the model to use. */
    model: string;
    /** The system instructions for the assistant to use. */
    instructions: string | null;
    /** The collection of tools enabled for the assistant. */
    tools: Array<ToolDefinitionOutput>;
    /** A list of attached file IDs, ordered by creation date in ascending order. */
    file_ids: string[];
    /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */
    metadata: TypeSpecRecordOutput | null;
}
/** The status of an assistant deletion operation. */
export interface AssistantDeletionStatusOutput extends DeletionStatusOutput {
}
/** An abstract representation of an OpenAI deletion operation result status. */
export interface DeletionStatusOutput {
    /** The ID of the resource specified for deletion. */
    id: string;
    /** A value indicating whether deletion was successful. */
    deleted: boolean;
}
/** The status of an assistant file deletion operation. */
export interface AssistantFileDeletionStatusOutput extends DeletionStatusOutput {
}
/** The status of a thread deletion operation. */
export interface ThreadDeletionStatusOutput extends DeletionStatusOutput {
}
/** A status response from a file deletion operation. */
export interface FileDeletionStatusOutput extends DeletionStatusOutput {
}
/** Information about a file attached to an assistant, as used by tools that can read files. */
export interface AssistantFileOutput {
    /** The identifier, which can be referenced in API endpoints. */
    id: string;
    /** The Unix timestamp, in seconds, representing when this object was created. */
    created_at: number;
    /** The assistant ID that the file is attached to. */
    assistant_id: string;
}
/** Information about a single thread associated with an assistant. */
export interface AssistantThreadOutput {
    /** The identifier, which can be referenced in API endpoints. */
    id: string;
    /** The Unix timestamp, in seconds, representing when this object was created. */
    created_at: number;
    /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */
    metadata: TypeSpecRecordOutput | null;
}
/** A single, existing message within an assistant thread. */
export interface ThreadMessageOutput {
    /** The identifier, which can be referenced in API endpoints. */
    id: string;
    /** The Unix timestamp, in seconds, representing when this object was created. */
    created_at: number;
    /** The ID of the thread that this message belongs to. */
    thread_id: string;
    /**
     * The role associated with the assistant thread message.
     *
     * Possible values: "user", "assistant"
     */
    role: string;
    /** The list of content items associated with the assistant thread message. */
    content: Array<MessageContentOutput>;
    /** If applicable, the ID of the assistant that authored this message. */
    assistant_id?: string;
    /** If applicable, the ID of the run associated with the authoring of this message. */
    run_id?: string;
    /**
     * A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can
     * access files.
     */
    file_ids: string[];
    /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */
    metadata: TypeSpecRecordOutput | null;
}
/** An abstract representation of a single item of thread message content. */
export interface MessageContentOutputParent {
    type: string;
}
/** A representation of a textual item of thread message content. */
export interface MessageTextContentOutput {
    /** The object type, which is always 'text'. */
    type: "text";
    /** The text and associated annotations for this thread message content item. */
    text: MessageTextDetailsOutput;
}
/** The text and associated annotations for a single item of assistant thread message content. */
export interface MessageTextDetailsOutput {
    /** The text data. */
    value: string;
    /** A list of annotations associated with this text. */
    annotations: Array<MessageTextAnnotationOutput>;
}
/** A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files. */
export interface MessageTextFileCitationAnnotationOutput {
    /** The object type, which is always 'file_citation'. */
    type: "file_citation";
    /** The textual content associated with this text annotation item. */
    text: string;
    /** The first text index associated with this text annotation. */
    start_index: number;
    /** The last text index associated with this text annotation. */
    end_index: number;
    /**
     * A citation within the message that points to a specific quote from a specific file.
     * Generated when the assistant uses the "retrieval" tool to search files.
     */
    file_citation: MessageTextFileCitationDetailsOutput;
}
/** A representation of a file-based text citation, as used in a file-based annotation of text thread message content. */
export interface MessageTextFileCitationDetailsOutput {
    /** The ID of the file associated with this citation. */
    file_id: string;
    /** The specific quote cited in the associated file. */
    quote: string;
}
/** A citation within the message that points to a file located at a specific path. */
export interface MessageTextFilePathAnnotationOutput {
    /** The object type, which is always 'file_path'. */
    type: "file_path";
    /** The textual content associated with this text annotation item. */
    text: string;
    /** The first text index associated with this text annotation. */
    start_index: number;
    /** The last text index associated with this text annotation. */
    end_index: number;
    /** A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file. */
    file_path: MessageTextFilePathDetailsOutput;
}
/** An encapsulation of an image file ID, as used by message image content. */
export interface MessageTextFilePathDetailsOutput {
    /** The ID of the specific file that the citation is from. */
    file_id: string;
}
/** A representation of image file content in a thread message. */
export interface MessageImageFileContentOutput {
    /** The object type, which is always 'image_file'. */
    type: "image_file";
    /** The image file for this thread message content item. */
    image_file: MessageImageFileDetailsOutput;
}
/** An image reference, as represented in thread message content. */
export interface MessageImageFileDetailsOutput {
    /** The ID for the file associated with this image. */
    file_id: MessageImageFileIdDetailsOutput;
}
/** An encapsulation of an image file ID, as used by message image content. */
export interface MessageImageFileIdDetailsOutput {
    /** The ID of the specific image file. */
    file_id: string;
}
/** Information about a file attached to an assistant thread message. */
export interface MessageFileOutput {
    /** The identifier, which can be referenced in API endpoints. */
    id: string;
    /** The Unix timestamp, in seconds, representing when this object was created. */
    created_at: number;
    /** The ID of the message that this file is attached to. */
    message_id: string;
}
/** Data representing a single evaluation run of an assistant thread. */
export interface ThreadRunOutput {
    /** The identifier, which can be referenced in API endpoints. */
    id: string;
    /** The ID of the thread associated with this run. */
    thread_id: string;
    /** The ID of the assistant associated with the thread this run was performed against. */
    assistant_id: string;
    /**
     * The status of the assistant thread run.
     *
     * Possible values: "queued", "in_progress", "requires_action", "cancelling", "cancelled", "failed", "completed", "expired"
     */
    status: string;
    /** The details of the action required for the assistant thread run to continue. */
    required_action?: RequiredActionOutput | null;
    /** The last error, if any, encountered by this assistant thread run. */
    last_error: RunErrorOutput | null;
    /** The ID of the model to use. */
    model: string;
    /** The overridden system instructions used for this assistant thread run. */
    instructions: string;
    /** The overridden enabled tools used for this assistant thread run. */
    tools: Array<ToolDefinitionOutput>;
    /** A list of attached file IDs, ordered by creation date in ascending order. */
    file_ids: string[];
    /** The Unix timestamp, in seconds, representing when this object was created. */
    created_at: number;
    /** The Unix timestamp, in seconds, representing when this item expires. */
    expires_at: string | null;
    /** The Unix timestamp, in seconds, representing when this item was started. */
    started_at: string | null;
    /** The Unix timestamp, in seconds, representing when this completed. */
    completed_at: string | null;
    /** The Unix timestamp, in seconds, representing when this was cancelled. */
    cancelled_at: string | null;
    /** The Unix timestamp, in seconds, representing when this failed. */
    failed_at: string | null;
    /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */
    metadata: TypeSpecRecordOutput | null;
}
/** The details for required tool calls that must be submitted for an assistant thread run to continue. */
export interface SubmitToolOutputsActionOutput {
    /** The ID of the tool call. This ID must be referenced when submitting tool outputs. */
    id: string;
    /** The object type, which is always 'submit_tool_outputs'. */
    type: "submit_tool_outputs";
    /** The details describing tools that should be called to submit tool outputs. */
    submit_tool_outputs: SubmitToolOutputsDetailsOutput;
}
/** The details describing tools that should be called to submit tool outputs. */
export interface SubmitToolOutputsDetailsOutput {
    /** The list of tool calls that must be resolved for the assistant thread run to continue. */
    tool_calls: Array<RequiredToolCallOutput>;
}
/** A representation of a requested call to a function tool, needed by the model to continue evaluation of a run. */
export interface RequiredFunctionToolCallOutput {
    /** The ID of the tool call. This ID must be referenced when submitting tool outputs. */
    id: string;
    /** The object type of the required tool call. Always 'function' for function tools. */
    type: "function";
    /** Detailed information about the function to be executed by the tool that includes name and arguments. */
    function: FunctionToolCallDetailsOutput;
}
/** The details of an error as encountered by an assistant thread run. */
export interface RunErrorOutput {
    /** The status for the error. */
    code: string;
    /** The human-readable text associated with the error. */
    message: string;
}
/** Detailed information about a single step of an assistant thread run. */
export interface RunStepOutput {
    /** The identifier, which can be referenced in API endpoints. */
    id: string;
    /**
     * The type of run step, which can be either message_creation or tool_calls.
     *
     * Possible values: "message_creation", "tool_calls"
     */
    type: string;
    /** The ID of the assistant associated with the run step. */
    assistant_id: string;
    /** The ID of the thread that was run. */
    thread_id: string;
    /** The ID of the run that this run step is a part of. */
    run_id: string;
    /**
     * The status of this run step.
     *
     * Possible values: "in_progress", "cancelled", "failed", "completed", "expired"
     */
    status: string;
    /** The details for this run step. */
    step_details: RunStepDetailsOutput;
    /** If applicable, information about the last error encountered by this run step. */
    last_error: RunStepErrorOutput | null;
    /** The Unix timestamp, in seconds, representing when this object was created. */
    created_at: number;
    /** The Unix timestamp, in seconds, representing when this item expired. */
    expired_at: string | null;
    /** The Unix timestamp, in seconds, representing when this completed. */
    completed_at: string | null;
    /** The Unix timestamp, in seconds, representing when this was cancelled. */
    cancelled_at: string | null;
    /** The Unix timestamp, in seconds, representing when this failed. */
    failed_at: string | null;
    /** A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. */
    metadata: TypeSpecRecordOutput | null;
}
/** The detailed information associated with a message creation run step. */
export interface RunStepMessageCreationDetailsOutput {
    /** The object type, which is always 'message_creation'. */
    type: "message_creation";
    /** Information about the message creation associated with this run step. */
    message_creation: RunStepMessageCreationReferenceOutput;
}
/** The details of a message created as a part of a run step. */
export interface RunStepMessageCreationReferenceOutput {
    /** The ID of the message created by this run step. */
    message_id: string;
}
/** The detailed information associated with a run step calling tools. */
export interface RunStepToolCallDetailsOutput {
    /** The object type, which is always 'tool_calls'. */
    type: "tool_calls";
    /** A list of tool call details for this run step. */
    tool_calls: Array<ToolCallOutput>;
}
/**
 * A record of a call to a code interpreter tool, issued by the model in evaluation of a defined tool, that
 * represents inputs and outputs consumed and emitted by the code interpreter.
 */
export interface CodeInterpreterToolCallOutput {
    /** The ID of the tool call. This ID must be referenced when you submit tool outputs. */
    id: string;
    /** The object type, which is always 'code_interpreter'. */
    type: "code_interpreter";
    /** The details of the tool call to the code interpreter tool. */
    code_interpreter: CodeInterpreterToolCallDetailsOutput;
}
/** The detailed information about a code interpreter invocation by the model. */
export interface CodeInterpreterToolCallDetailsOutput {
    /** The input provided by the model to the code interpreter tool. */
    input: string;
    /** The outputs produced by the code interpreter tool back to the model in response to the tool call. */
    outputs: Array<CodeInterpreterToolCallOutputOutput>;
}
/** A representation of a log output emitted by a code interpreter tool in response to a tool call by the model. */
export interface CodeInterpreterLogOutputOutput {
    /** The object type, which is always 'logs'. */
    type: "logs";
    /** The serialized log output emitted by the code interpreter. */
    logs: string;
}
/** A representation of an image output emitted by a code interpreter tool in response to a tool call by the model. */
export interface CodeInterpreterImageOutputOutput {
    /** The object type, which is always 'image'. */
    type: "image";
    /** Referential information for the image associated with this output. */
    image: CodeInterpreterImageReferenceOutput;
}
/** An image reference emitted by a code interpreter tool in response to a tool call by the model. */
export interface CodeInterpreterImageReferenceOutput {
    /** The ID of the file associated with this image. */
    file_id: string;
}
/**
 * A record of a call to a retrieval tool, issued by the model in evaluation of a defined tool, that represents
 * executed retrieval actions.
 */
export interface RetrievalToolCallOutput {
    /** The ID of the tool call. This ID must be referenced when you submit tool outputs. */
    id: string;
    /** The object type, which is always 'retrieval'. */
    type: "retrieval";
    /** The key/value pairs produced by the retrieval tool. */
    retrieval: TypeSpecRecordOutput;
}
/**
 * A record of a call to a function tool, issued by the model in evaluation of a defined tool, that represents the inputs
 * and output consumed and emitted by the specified function.
 */
export interface FunctionToolCallOutput {
    /** The ID of the tool call. This ID must be referenced when you submit tool outputs. */
    id: string;
    /** The object type, which is always 'function'. */
    type: "function";
    /** The detailed information about the function called by the model. */
    function: FunctionToolCallDetailsOutput;
}
/** The detailed information about the function called by the model. */
export interface FunctionToolCallDetailsOutput {
    /** The name of the function. */
    name: string;
    /** The arguments that the model requires are provided to the named function. */
    arguments: string;
    /** The output of the function, only populated for function calls that have already have had their outputs submitted. */
    output: string | null;
}
/** The error information associated with a failed run step. */
export interface RunStepErrorOutput {
    /**
     * The error code for this error.
     *
     * Possible values: "server_error", "rate_limit_exceeded"
     */
    code: string;
    /** The human-readable text associated with this error. */
    message: string;
}
/** The response data from a file list operation. */
export interface FileListResponseOutput {
    /** The files returned for the request. */
    data: Array<OpenAIFileOutput>;
}
/** Represents an assistant that can call the model and use tools. */
export interface OpenAIFileOutput {
    /** The identifier, which can be referenced in API endpoints. */
    id: string;
    /** The size of the file, in bytes. */
    bytes: number;
    /** The name of the file. */
    filename: string;
    /** The Unix timestamp, in seconds, representing when this object was created. */
    created_at: number;
    /**
     * The intended purpose of a file.
     *
     * Possible values: "fine-tune", "fine-tune-results", "assistants", "assistants_output"
     */
    purpose: string;
}
/** The response data for a requested list of items. */
export interface ListResponseOfOutput<T> {
    /** The requested list of items. */
    data: T[];
    /** The first ID represented in this list. */
    first_id: string;
    /** The last ID represented in this list. */
    last_id: string;
    /** A value indicating whether there are additional values available not captured in this list. */
    has_more: boolean;
}
/** An abstract representation of an annotation to text thread message content. */
export type MessageTextAnnotationOutput = MessageTextFileCitationAnnotationOutput | MessageTextFilePathAnnotationOutput;
/** An abstract representation of a required action for an assistant thread run to continue. */
export type RequiredActionOutput = SubmitToolOutputsActionOutput;
/** An abstract representation a a tool invocation needed by the model to continue a run. */
export type RequiredToolCallOutput = RequiredFunctionToolCallOutput;
/** An abstract representation of the details for a run step. */
export type RunStepDetailsOutput = RunStepMessageCreationDetailsOutput | RunStepToolCallDetailsOutput;
/** An abstract representation of an emitted output from a code interpreter tool. */
export type CodeInterpreterToolCallOutputOutput = CodeInterpreterLogOutputOutput | CodeInterpreterImageOutputOutput;
/** An abstract representation of an input tool definition that an assistant can use. */
export type ToolDefinitionOutput = CodeInterpreterToolDefinitionOutput | RetrievalToolDefinitionOutput | FunctionToolDefinitionOutput;
/** An abstract representation of a single item of thread message content. */
export type MessageContentOutput = MessageTextContentOutput | MessageImageFileContentOutput;
/**
 * An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must
 * be fulfilled and have its outputs submitted before the model can continue.
 */
export type ToolCallOutput = FunctionToolCallOutput | CodeInterpreterToolCallOutput | RetrievalToolCallOutput;
//# sourceMappingURL=outputModels.d.ts.map