View Source ExOpenAI.Components.WebSearchActionSearch (ex_openai.ex v2.0.0-beta2)

Action type "search" - Performs a web search query.

Fields

  • :queries - optional - [String.t()]
    The search queries.

  • :query - required - String.t()
    [DEPRECATED] The search query.

  • :sources - optional - [{:%{}, [], [{{:required, [], [:type]}, :url}, {{:required, [], [:url]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}]}]
    The sources used in the search.

  • :type - required - :search
    The action type.
    Allowed values: "search"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.WebSearchActionSearch{
  queries: [String.t()] | nil,
  query: String.t(),
  sources: [%{type: :url, url: String.t()}] | nil,
  type: :search
}