Files
go-openai/search.go
noona 51f94a6ab3 rev-1: Added some fixes & improvements (#26)
* Added support for Moderations API

* gofmt moderation.go

* support for edits endpoint & other improvements

* fix: Choice redeclared in this block

* Added more parameters for the Search endpoint. (#3)
2022-07-03 23:51:02 +06:00

59 lines
1.5 KiB
Go

package gogpt
import (
"bytes"
"context"
"encoding/json"
"fmt"
"net/http"
)
/*
- SearchRequest represents a request structure for search API.
- Info (*):
- 1*) You should specify either 'documents' or a 'file', but not both.
- 2*) This flag only takes effect when file is set.
*/
type SearchRequest struct {
Query string `json:"query"`
Documents []string `json:"documents"` // 1*
FileID string `json:"file"` // 1*
MaxRerank int `json:"max_rerank"` // 2*
ReturnMetadata bool `json:"return_metadata"`
User string `json:"user"`
}
// SearchResult represents single result from search API
type SearchResult struct {
Document int `json:"document"`
Object string `json:"object"`
Score float32 `json:"score"`
Metadata string `json:"metadata"` // 2*
}
// SearchResponse represents a response structure for search API
type SearchResponse struct {
SearchResults []SearchResult `json:"data"`
Object string `json:"object"`
}
// Search — perform a semantic search api call over a list of documents.
func (c *Client) Search(ctx context.Context, engineID string, request SearchRequest) (response SearchResponse, err error) {
var reqBytes []byte
reqBytes, err = json.Marshal(request)
if err != nil {
return
}
urlSuffix := fmt.Sprintf("/engines/%s/search", engineID)
req, err := http.NewRequest("POST", c.fullURL(urlSuffix), bytes.NewBuffer(reqBytes))
if err != nil {
return
}
req = req.WithContext(ctx)
err = c.sendRequest(req, &response)
return
}