FileSearch

sttp.openai.requests.threads.runs.ThreadRunsResponseData.FileSearchToolCall.FileSearch
See theFileSearch companion class
object FileSearch

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
FileSearch.type

Members list

Type members

Classlikes

case class FileSearchResult(fileId: String, fileName: String, score: Double, content: Seq[Content])

The results of the file search

The results of the file search

Value parameters

content

The content of the result that was found. The content is only included if requested via the include query parameter.

fileId

The ID of the file that result was found in

fileName

The name of the file that result was found in

score

The score of the result. All values must be a floating point number between 0 and 1.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class RankingOptions(ranker: String, scoreThreshold: Double)

The ranking options for the file search

The ranking options for the file search

Value parameters

ranker

The ranker to use for the file search. If not specified will use the auto ranker.

scoreThreshold

The score threshold for the file search. All values must be a floating point number between 0 and 1

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Implicits

Implicits

implicit val fileSearchR: Reader[FileSearch]