final case class CreateSearchRequest(query: Query, documents: Optional[NonEmptyChunk[String]] = Optional.Absent, file: Optional[String] = Optional.Absent, maxRerank: Optional[MaxRerank] = Optional.Absent, returnMetadata: Optional[Boolean] = Optional.Absent, user: Optional[String] = Optional.Absent) extends Product with Serializable

CreateSearchRequest model

query

Query to search against the documents.

documents

Up to 200 documents to search over, provided as a list of strings. The maximum document length (in tokens) is 2034 minus the number of tokens in the query. You should specify either documents or a file, but not both.

file

The ID of an uploaded file that contains documents to search over. You should specify either documents or a file, but not both.

maxRerank

The maximum number of documents to be re-ranked and returned by search. This flag only takes effect when file is set.

returnMetadata

A special boolean flag for showing metadata. If set to true, each document entry in the returned JSON will contain a "metadata" field. This flag only takes effect when file is set.

user

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CreateSearchRequest
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CreateSearchRequest(query: Query, documents: Optional[NonEmptyChunk[String]] = Optional.Absent, file: Optional[String] = Optional.Absent, maxRerank: Optional[MaxRerank] = Optional.Absent, returnMetadata: Optional[Boolean] = Optional.Absent, user: Optional[String] = Optional.Absent)

    query

    Query to search against the documents.

    documents

    Up to 200 documents to search over, provided as a list of strings. The maximum document length (in tokens) is 2034 minus the number of tokens in the query. You should specify either documents or a file, but not both.

    file

    The ID of an uploaded file that contains documents to search over. You should specify either documents or a file, but not both.

    maxRerank

    The maximum number of documents to be re-ranked and returned by search. This flag only takes effect when file is set.

    returnMetadata

    A special boolean flag for showing metadata. If set to true, each document entry in the returned JSON will contain a "metadata" field. This flag only takes effect when file is set.

    user

    A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. val documents: Optional[NonEmptyChunk[String]]
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val file: Optional[String]
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val maxRerank: Optional[MaxRerank]
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def productElementNames: Iterator[String]
    Definition Classes
    Product
  17. val query: Query
  18. val returnMetadata: Optional[Boolean]
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. val user: Optional[String]
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped