Packages

oapi_open_ai

1.0.2
1.0.2 1.0.1 1.0.0 0.4.4 0.4.3 0.4.2 0.4.1 0.4.0 0.3.3 0.3.2 0.3.1 0.3.0 0.2.5 0.2.4 0.2.3 0.2.2 0.2.1 0.2.0 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1

OpenAI REST API Client

HexDocs

Current section

Files

Jump to
Readme
24 Versions
3 Dependencies
Dependants
Files
Activity
oapi_open_ai lib schemas response web_search preview_tool.ex
Raw

lib/schemas/response/web_search/preview_tool.ex 

defmodule OpenAi.Response.WebSearch.PreviewTool do

  @moduledoc """

  Provides struct and type for a Response.WebSearch.PreviewTool

  """



  @type t :: %__MODULE__{

          search_context_size: String.t() | nil,

          type: String.t(),

          user_location: OpenAi.User.ApproximateLocation.t() | nil

        }



  defstruct [:search_context_size, :type, :user_location]



  @doc false

  @spec __fields__(atom) :: keyword

  def __fields__(type \\ :t)



  def __fields__(:t) do

    [

      search_context_size: {:enum, ["low", "medium", "high"]},

      type: {:enum, ["web_search_preview", "web_search_preview_2025_03_11"]},

      user_location: {:union, [{OpenAi.User.ApproximateLocation, :t}, :null]}

    ]

  end

end