CreateSearchRequest class abstract

CreateSearchRequest

Properties:

  • 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.
Annotations
  • @BuiltValue()

Constructors

CreateSearchRequest([void updates(CreateSearchRequestBuilder b)])
factory

Properties

documents → BuiltList<String>?
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.
no setter
file → String?
The ID of an uploaded file that contains documents to search over. You should specify either documents or a file, but not both.
no setter
hashCode → int
The hash code for this object.
no setterinherited
maxRerank → int?
The maximum number of documents to be re-ranked and returned by search. This flag only takes effect when file is set.
no setter
query → String
Query to search against the documents.
no setter
returnMetadata → bool?
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.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
user → String?
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(CreateSearchRequestBuilder)) → CreateSearchRequest
Rebuilds the instance.
inherited
toBuilder() → CreateSearchRequestBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<CreateSearchRequest>
no setter