@raycast/api 1.49.2 → 1.50.0

package/api.d.ts

@@ -1000,7 +1000,7 @@ export declare namespace Color {
          * Raycast user interface. This makes it easy to guarantee a good look and feel when you aren't in control of the
          * color, e.g. get it via a network request.
          *
-         * @defaultValue `false`
+         * @defaultValue `true`
          */
         adjustContrast?: boolean | undefined | null;
     }
@@ -2169,6 +2169,21 @@ export declare interface Environment {
      * The type of launch for the command (user initiated or background).
      */
     launchType: LaunchType;
+    /**
+     * Returns whether the user has access to the given API.
+     *
+     *  @example
+     * ```typescript
+     * import { unstableAI, environment } from "@raycast/api";
+     *
+     * export default function Command() {
+     *   if (environment.canAccess(unstableAI)) {
+     *     // use unstableAI
+     *   }
+     * }
+     * ```
+     */
+    canAccess(api: unknown): boolean;
     /**
      * @deprecated Use the top-level prop `launchContext` instead.
      */
@@ -4773,6 +4788,7 @@ export declare enum Icon {
     Terminal = "terminal-16",
     Text = "text-16",
     TextCursor = "text-cursor-16",
+    TextInput = "text-input-16",
     Torch = "torch-16",
     Train = "train-16",
     Trash = "trash-16",
@@ -7917,14 +7933,19 @@ export declare namespace unstable_AI {
      * }
      * ```
      */
-    export function ask(prompt: string, options?: AnswerOptions): Promise<string> & {
+    export function ask(prompt: string, options?: AskOptions): Promise<string> & {
         on(event: "data", listener: (chunk: string) => void): void;
     };
-    export type AnswerOptions = {
+    export type AskOptions = {
         /**
-         * Between 0 and 1
+         * Concrete tasks, such as fixing grammar, require less creativity while open-ended questions, such as generating ideas, require more.
+         * If a number is passed, it needs to be in the range 0-2. For larger values, 2 will be used. For lower values, 0 will be used.
          */
         creativity?: Creativity;
+        /**
+         * The AI model to use to answer to the prompt.
+         */
+        model?: Model;
         /**
          * Abort signal to cancel the request.
          */
@@ -7935,6 +7956,10 @@ export declare namespace unstable_AI {
      * If a number is passed, it needs to be in the range 0-2. For larger values, 2 will be used. For lower values, 0 will be used.
      */
     export type Creativity = "none" | "low" | "medium" | "high" | "maximum" | number;
+    /**
+     * @default `"text-davinci-003"``
+     */
+    export type Model = "text-davinci-003" | "gpt-3.5-turbo";
 }
 
 /**
@@ -8040,7 +8065,15 @@ export declare function useNavigation(): Navigation;
  * ```
  */
 export declare function useUnstableAI(prompt: string, options?: {
+    /**
+     * Concrete tasks, such as fixing grammar, require less creativity while open-ended questions, such as generating ideas, require more.
+     * If a number is passed, it needs to be in the range 0-2. For larger values, 2 will be used. For lower values, 0 will be used.
+     */
     creativity?: unstable_AI.Creativity;
+    /**
+     * The AI model to use to answer to the prompt.
+     */
+    model?: unstable_AI.Model;
     stream?: boolean;
 } & Omit<PromiseOptions<FunctionReturningPromise>, "abortable">): {
     isLoading: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raycast/api",
-  "version": "1.49.2",
+  "version": "1.50.0",
   "description": "Build extensions for Raycast with React and Node.js.",
   "author": "Raycast Technologies Ltd.",
   "homepage": "https://developers.raycast.com",

package/types/index.d.ts

@@ -996,7 +996,7 @@ export declare namespace Color {
          * Raycast user interface. This makes it easy to guarantee a good look and feel when you aren't in control of the
          * color, e.g. get it via a network request.
          *
-         * @defaultValue `false`
+         * @defaultValue `true`
          */
         adjustContrast?: boolean | undefined | null;
     }
@@ -2165,6 +2165,21 @@ export declare interface Environment {
      * The type of launch for the command (user initiated or background).
      */
     launchType: LaunchType;
+    /**
+     * Returns whether the user has access to the given API.
+     *
+     *  @example
+     * ```typescript
+     * import { unstableAI, environment } from "@raycast/api";
+     *
+     * export default function Command() {
+     *   if (environment.canAccess(unstableAI)) {
+     *     // use unstableAI
+     *   }
+     * }
+     * ```
+     */
+    canAccess(api: unknown): boolean;
     /**
      * @deprecated Use the top-level prop `launchContext` instead.
      */
@@ -4769,6 +4784,7 @@ export declare enum Icon {
     Terminal = "terminal-16",
     Text = "text-16",
     TextCursor = "text-cursor-16",
+    TextInput = "text-input-16",
     Torch = "torch-16",
     Train = "train-16",
     Trash = "trash-16",
@@ -7913,14 +7929,19 @@ export declare namespace unstable_AI {
      * }
      * ```
      */
-    export function ask(prompt: string, options?: AnswerOptions): Promise<string> & {
+    export function ask(prompt: string, options?: AskOptions): Promise<string> & {
         on(event: "data", listener: (chunk: string) => void): void;
     };
-    export type AnswerOptions = {
+    export type AskOptions = {
         /**
-         * Between 0 and 1
+         * Concrete tasks, such as fixing grammar, require less creativity while open-ended questions, such as generating ideas, require more.
+         * If a number is passed, it needs to be in the range 0-2. For larger values, 2 will be used. For lower values, 0 will be used.
          */
         creativity?: Creativity;
+        /**
+         * The AI model to use to answer to the prompt.
+         */
+        model?: Model;
         /**
          * Abort signal to cancel the request.
          */
@@ -7931,6 +7952,10 @@ export declare namespace unstable_AI {
      * If a number is passed, it needs to be in the range 0-2. For larger values, 2 will be used. For lower values, 0 will be used.
      */
     export type Creativity = "none" | "low" | "medium" | "high" | "maximum" | number;
+    /**
+     * @default `"text-davinci-003"``
+     */
+    export type Model = "text-davinci-003" | "gpt-3.5-turbo";
 }
 
 /**
@@ -8036,7 +8061,15 @@ export declare function useNavigation(): Navigation;
  * ```
  */
 export declare function useUnstableAI(prompt: string, options?: {
+    /**
+     * Concrete tasks, such as fixing grammar, require less creativity while open-ended questions, such as generating ideas, require more.
+     * If a number is passed, it needs to be in the range 0-2. For larger values, 2 will be used. For lower values, 0 will be used.
+     */
     creativity?: unstable_AI.Creativity;
+    /**
+     * The AI model to use to answer to the prompt.
+     */
+    model?: unstable_AI.Model;
     stream?: boolean;
 } & Omit<PromiseOptions<FunctionReturningPromise>, "abortable">): {
     isLoading: boolean;