2020-10-05 17:44:18 -05:00
|
|
|
package com.theokanning.openai.search;
|
2020-10-04 18:25:40 -05:00
|
|
|
|
|
|
|
import lombok.Data;
|
|
|
|
|
2020-10-04 19:24:24 -05:00
|
|
|
/**
|
|
|
|
* A search result for a single document.
|
|
|
|
*
|
2022-04-28 16:48:33 -05:00
|
|
|
* https://beta.openai.com/docs/api-reference/searches
|
2020-10-04 19:24:24 -05:00
|
|
|
*/
|
2022-08-19 10:49:22 -05:00
|
|
|
@Deprecated
|
2020-10-04 18:25:40 -05:00
|
|
|
@Data
|
|
|
|
public class SearchResult {
|
2020-10-04 19:24:24 -05:00
|
|
|
/**
|
|
|
|
* The position of this document in the request list
|
|
|
|
*/
|
2020-10-04 18:25:40 -05:00
|
|
|
Integer document;
|
2020-10-04 19:24:24 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The type of object returned, should be "search_result"
|
|
|
|
*/
|
2020-10-04 18:25:40 -05:00
|
|
|
String object;
|
2020-10-04 19:24:24 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* A number measuring the document's correlation with the query.
|
|
|
|
* A higher score means a stronger relationship.
|
|
|
|
*/
|
2020-10-04 18:25:40 -05:00
|
|
|
Double score;
|
|
|
|
}
|