@neurocode-ai/core 1.18.8

package/src/github-copilot/responses/openai-responses-api-types.ts

@@ -0,0 +1,214 @@
+import type { JSONSchema7 } from "@ai-sdk/provider"
+
+export type OpenAIResponsesInput = Array<OpenAIResponsesInputItem>
+
+export type OpenAIResponsesInputItem =
+  | OpenAIResponsesSystemMessage
+  | OpenAIResponsesUserMessage
+  | OpenAIResponsesAssistantMessage
+  | OpenAIResponsesFunctionCall
+  | OpenAIResponsesFunctionCallOutput
+  | OpenAIResponsesComputerCall
+  | OpenAIResponsesLocalShellCall
+  | OpenAIResponsesLocalShellCallOutput
+  | OpenAIResponsesReasoning
+  | OpenAIResponsesItemReference
+  | OpenAIResponsesMcpApprovalResponse
+
+export type OpenAIResponsesIncludeValue =
+  | "web_search_call.action.sources"
+  | "code_interpreter_call.outputs"
+  | "computer_call_output.output.image_url"
+  | "file_search_call.results"
+  | "message.input_image.image_url"
+  | "message.output_text.logprobs"
+  | "reasoning.encrypted_content"
+
+export type OpenAIResponsesIncludeOptions = Array<OpenAIResponsesIncludeValue> | undefined | null
+
+export type OpenAIResponsesSystemMessage = {
+  role: "system" | "developer"
+  content: string
+}
+
+export type OpenAIResponsesUserMessage = {
+  role: "user"
+  content: Array<
+    | { type: "input_text"; text: string }
+    | { type: "input_image"; image_url: string }
+    | { type: "input_image"; file_id: string }
+    | { type: "input_file"; file_url: string }
+    | { type: "input_file"; filename: string; file_data: string }
+    | { type: "input_file"; file_id: string }
+  >
+}
+
+export type OpenAIResponsesAssistantMessage = {
+  role: "assistant"
+  content: Array<{ type: "output_text"; text: string }>
+  id?: string
+}
+
+export type OpenAIResponsesFunctionCall = {
+  type: "function_call"
+  call_id: string
+  name: string
+  arguments: string
+  id?: string
+}
+
+export type OpenAIResponsesFunctionCallOutput = {
+  type: "function_call_output"
+  call_id: string
+  output: string
+}
+
+export type OpenAIResponsesComputerCall = {
+  type: "computer_call"
+  id: string
+  status?: string
+}
+
+export type OpenAIResponsesLocalShellCall = {
+  type: "local_shell_call"
+  id: string
+  call_id: string
+  action: {
+    type: "exec"
+    command: string[]
+    timeout_ms?: number
+    user?: string
+    working_directory?: string
+    env?: Record<string, string>
+  }
+}
+
+export type OpenAIResponsesLocalShellCallOutput = {
+  type: "local_shell_call_output"
+  call_id: string
+  output: string
+}
+
+export type OpenAIResponsesItemReference = {
+  type: "item_reference"
+  id: string
+}
+
+export type OpenAIResponsesMcpApprovalResponse = {
+  type: "mcp_approval_response"
+  approval_request_id: string
+  approve: boolean
+}
+
+/**
+ * A filter used to compare a specified attribute key to a given value using a defined comparison operation.
+ */
+export type OpenAIResponsesFileSearchToolComparisonFilter = {
+  /**
+   * The key to compare against the value.
+   */
+  key: string
+
+  /**
+   * Specifies the comparison operator: eq, ne, gt, gte, lt, lte.
+   */
+  type: "eq" | "ne" | "gt" | "gte" | "lt" | "lte"
+
+  /**
+   * The value to compare against the attribute key; supports string, number, or boolean types.
+   */
+  value: string | number | boolean
+}
+
+/**
+ * Combine multiple filters using and or or.
+ */
+export type OpenAIResponsesFileSearchToolCompoundFilter = {
+  /**
+   * Type of operation: and or or.
+   */
+  type: "and" | "or"
+
+  /**
+   * Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.
+   */
+  filters: Array<OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter>
+}
+
+export type OpenAIResponsesTool =
+  | {
+      type: "function"
+      name: string
+      description: string | undefined
+      parameters: JSONSchema7
+      strict: boolean | undefined
+    }
+  | {
+      type: "web_search"
+      filters: { allowed_domains: string[] | undefined } | undefined
+      search_context_size: "low" | "medium" | "high" | undefined
+      user_location:
+        | {
+            type: "approximate"
+            city?: string
+            country?: string
+            region?: string
+            timezone?: string
+          }
+        | undefined
+    }
+  | {
+      type: "web_search_preview"
+      search_context_size: "low" | "medium" | "high" | undefined
+      user_location:
+        | {
+            type: "approximate"
+            city?: string
+            country?: string
+            region?: string
+            timezone?: string
+          }
+        | undefined
+    }
+  | {
+      type: "code_interpreter"
+      container: string | { type: "auto"; file_ids: string[] | undefined }
+    }
+  | {
+      type: "file_search"
+      vector_store_ids: string[]
+      max_num_results: number | undefined
+      ranking_options: { ranker?: string; score_threshold?: number } | undefined
+      filters: OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter | undefined
+    }
+  | {
+      type: "image_generation"
+      background: "auto" | "opaque" | "transparent" | undefined
+      input_fidelity: "low" | "high" | undefined
+      input_image_mask:
+        | {
+            file_id: string | undefined
+            image_url: string | undefined
+          }
+        | undefined
+      model: string | undefined
+      moderation: "auto" | undefined
+      output_compression: number | undefined
+      output_format: "png" | "jpeg" | "webp" | undefined
+      partial_images: number | undefined
+      quality: "auto" | "low" | "medium" | "high" | undefined
+      size: "auto" | "1024x1024" | "1024x1536" | "1536x1024" | undefined
+    }
+  | {
+      type: "local_shell"
+    }
+
+export type OpenAIResponsesReasoning = {
+  type: "reasoning"
+  id: string
+  encrypted_content?: string | null
+  summary: Array<{
+    type: "summary_text"
+    text: string
+  }>
+}