api

package

Go to main page

Versions in this module

v1

v1.0.4

Sep 23, 2024

Changes in this version

type MultiSearchCollectionParameters

+ FacetStrategy *string

type MultiSearchParameters

+ FacetStrategy *string

type MultiSearchParams

+ FacetStrategy *string

type SearchCollectionParams

+ FacetStrategy *string

v1.0.3

Jun 12, 2024

Changes in this version

type MultiSearchCollectionParameters

+ FilterCuratedHits *bool

type MultiSearchParameters

+ FilterCuratedHits *bool

type MultiSearchParams

+ FilterCuratedHits *bool

type SearchCollectionParams

+ FilterCuratedHits *bool

v1.0.2

Jun 12, 2024

Changes in this version

type MultiSearchCollectionParameters

+ FilterPinnedHits *bool

type MultiSearchParameters

+ FilterPinnedHits *bool

type MultiSearchParams

+ FilterPinnedHits *bool

type SearchCollectionParams

+ FilterPinnedHits *bool

v1.0.1

Jun 9, 2024

v0

v0.8.3

Sep 15, 2023

Changes in this version

+ const APIKeyHeader

+ const Api_key_headerScopes

+ func NewCreateCollectionRequest(server string, body CreateCollectionJSONRequestBody) (*http.Request, error)

+ func NewCreateCollectionRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

+ func NewCreateKeyRequest(server string, body CreateKeyJSONRequestBody) (*http.Request, error)

+ func NewCreateKeyRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

+ func NewDebugRequest(server string) (*http.Request, error)

+ func NewDeleteAliasRequest(server string, aliasName string) (*http.Request, error)

+ func NewDeleteCollectionRequest(server string, collectionName string) (*http.Request, error)

+ func NewDeleteDocumentRequest(server string, collectionName string, documentId string) (*http.Request, error)

+ func NewDeleteDocumentsRequest(server string, collectionName string, params *DeleteDocumentsParams) (*http.Request, error)

+ func NewDeleteKeyRequest(server string, keyId int64) (*http.Request, error)

+ func NewDeleteSearchOverrideRequest(server string, collectionName string, overrideId string) (*http.Request, error)

+ func NewDeleteSearchSynonymRequest(server string, collectionName string, synonymId string) (*http.Request, error)

+ func NewExportDocumentsRequest(server string, collectionName string, params *ExportDocumentsParams) (*http.Request, error)

+ func NewGetAliasRequest(server string, aliasName string) (*http.Request, error)

+ func NewGetAliasesRequest(server string) (*http.Request, error)

+ func NewGetCollectionRequest(server string, collectionName string) (*http.Request, error)

+ func NewGetCollectionsRequest(server string) (*http.Request, error)

+ func NewGetDocumentRequest(server string, collectionName string, documentId string) (*http.Request, error)

+ func NewGetKeyRequest(server string, keyId int64) (*http.Request, error)

+ func NewGetKeysRequest(server string) (*http.Request, error)

+ func NewGetSearchOverrideRequest(server string, collectionName string, overrideId string) (*http.Request, error)

+ func NewGetSearchOverridesRequest(server string, collectionName string) (*http.Request, error)

+ func NewGetSearchSynonymRequest(server string, collectionName string, synonymId string) (*http.Request, error)

+ func NewGetSearchSynonymsRequest(server string, collectionName string) (*http.Request, error)

+ func NewHealthRequest(server string) (*http.Request, error)

+ func NewImportDocumentsRequestWithBody(server string, collectionName string, params *ImportDocumentsParams, ...) (*http.Request, error)

+ func NewIndexDocumentRequest(server string, collectionName string, params *IndexDocumentParams, ...) (*http.Request, error)

+ func NewIndexDocumentRequestWithBody(server string, collectionName string, params *IndexDocumentParams, ...) (*http.Request, error)

+ func NewMultiSearchRequest(server string, params *MultiSearchParams, body MultiSearchJSONRequestBody) (*http.Request, error)

+ func NewMultiSearchRequestWithBody(server string, params *MultiSearchParams, contentType string, body io.Reader) (*http.Request, error)

+ func NewSearchCollectionRequest(server string, collectionName string, params *SearchCollectionParams) (*http.Request, error)

+ func NewTakeSnapshotRequest(server string, params *TakeSnapshotParams) (*http.Request, error)

+ func NewUpdateCollectionRequest(server string, collectionName string, body UpdateCollectionJSONRequestBody) (*http.Request, error)

+ func NewUpdateCollectionRequestWithBody(server string, collectionName string, contentType string, body io.Reader) (*http.Request, error)

+ func NewUpdateDocumentRequest(server string, collectionName string, documentId string, ...) (*http.Request, error)

+ func NewUpdateDocumentRequestWithBody(server string, collectionName string, documentId string, contentType string, ...) (*http.Request, error)

+ func NewUpdateDocumentsRequest(server string, collectionName string, params *UpdateDocumentsParams, ...) (*http.Request, error)

+ func NewUpdateDocumentsRequestWithBody(server string, collectionName string, params *UpdateDocumentsParams, ...) (*http.Request, error)

+ func NewUpsertAliasRequest(server string, aliasName string, body UpsertAliasJSONRequestBody) (*http.Request, error)

+ func NewUpsertAliasRequestWithBody(server string, aliasName string, contentType string, body io.Reader) (*http.Request, error)

+ func NewUpsertSearchOverrideRequest(server string, collectionName string, overrideId string, ...) (*http.Request, error)

+ func NewUpsertSearchOverrideRequestWithBody(server string, collectionName string, overrideId string, contentType string, ...) (*http.Request, error)

+ func NewUpsertSearchSynonymRequest(server string, collectionName string, synonymId string, ...) (*http.Request, error)

+ func NewUpsertSearchSynonymRequestWithBody(server string, collectionName string, synonymId string, contentType string, ...) (*http.Request, error)

+ func NewVoteRequest(server string) (*http.Request, error)

+ type ApiKey struct

+ Actions []string

+ Collections []string

+ Description string

+ ExpiresAt *int64

+ Id *int64

+ Value *string

+ ValuePrefix *string

+ type ApiKeySchema struct

+ Actions []string

+ Collections []string

+ Description string

+ ExpiresAt *int64

+ Value *string

+ type ApiKeysResponse struct

+ Keys []*ApiKey

+ type ApiResponse struct

+ Message string

+ type Client struct

+ Client HttpRequestDoer

+ RequestEditors []RequestEditorFn

+ Server string

+ func NewClient(server string, opts ...ClientOption) (*Client, error)

+ func (c *Client) CreateCollection(ctx context.Context, body CreateCollectionJSONRequestBody, ...) (*http.Response, error)

+ func (c *Client) CreateCollectionWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ func (c *Client) CreateKey(ctx context.Context, body CreateKeyJSONRequestBody, ...) (*http.Response, error)

+ func (c *Client) CreateKeyWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ func (c *Client) Debug(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) DeleteAlias(ctx context.Context, aliasName string, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) DeleteCollection(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) DeleteDocument(ctx context.Context, collectionName string, documentId string, ...) (*http.Response, error)

+ func (c *Client) DeleteDocuments(ctx context.Context, collectionName string, params *DeleteDocumentsParams, ...) (*http.Response, error)

+ func (c *Client) DeleteKey(ctx context.Context, keyId int64, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) DeleteSearchOverride(ctx context.Context, collectionName string, overrideId string, ...) (*http.Response, error)

+ func (c *Client) DeleteSearchSynonym(ctx context.Context, collectionName string, synonymId string, ...) (*http.Response, error)

+ func (c *Client) ExportDocuments(ctx context.Context, collectionName string, params *ExportDocumentsParams, ...) (*http.Response, error)

+ func (c *Client) GetAlias(ctx context.Context, aliasName string, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) GetAliases(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) GetCollection(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) GetCollections(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) GetDocument(ctx context.Context, collectionName string, documentId string, ...) (*http.Response, error)

+ func (c *Client) GetKey(ctx context.Context, keyId int64, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) GetKeys(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) GetSearchOverride(ctx context.Context, collectionName string, overrideId string, ...) (*http.Response, error)

+ func (c *Client) GetSearchOverrides(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) GetSearchSynonym(ctx context.Context, collectionName string, synonymId string, ...) (*http.Response, error)

+ func (c *Client) GetSearchSynonyms(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) Health(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) ImportDocumentsWithBody(ctx context.Context, collectionName string, params *ImportDocumentsParams, ...) (*http.Response, error)

+ func (c *Client) IndexDocument(ctx context.Context, collectionName string, params *IndexDocumentParams, ...) (*http.Response, error)

+ func (c *Client) IndexDocumentWithBody(ctx context.Context, collectionName string, params *IndexDocumentParams, ...) (*http.Response, error)

+ func (c *Client) MultiSearch(ctx context.Context, params *MultiSearchParams, ...) (*http.Response, error)

+ func (c *Client) MultiSearchWithBody(ctx context.Context, params *MultiSearchParams, contentType string, ...) (*http.Response, error)

+ func (c *Client) SearchCollection(ctx context.Context, collectionName string, params *SearchCollectionParams, ...) (*http.Response, error)

+ func (c *Client) TakeSnapshot(ctx context.Context, params *TakeSnapshotParams, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) UpdateCollection(ctx context.Context, collectionName string, ...) (*http.Response, error)

+ func (c *Client) UpdateCollectionWithBody(ctx context.Context, collectionName string, contentType string, body io.Reader, ...) (*http.Response, error)

+ func (c *Client) UpdateDocument(ctx context.Context, collectionName string, documentId string, ...) (*http.Response, error)

+ func (c *Client) UpdateDocumentWithBody(ctx context.Context, collectionName string, documentId string, ...) (*http.Response, error)

+ func (c *Client) UpdateDocuments(ctx context.Context, collectionName string, params *UpdateDocumentsParams, ...) (*http.Response, error)

+ func (c *Client) UpdateDocumentsWithBody(ctx context.Context, collectionName string, params *UpdateDocumentsParams, ...) (*http.Response, error)

+ func (c *Client) UpsertAlias(ctx context.Context, aliasName string, body UpsertAliasJSONRequestBody, ...) (*http.Response, error)

+ func (c *Client) UpsertAliasWithBody(ctx context.Context, aliasName string, contentType string, body io.Reader, ...) (*http.Response, error)

+ func (c *Client) UpsertSearchOverride(ctx context.Context, collectionName string, overrideId string, ...) (*http.Response, error)

+ func (c *Client) UpsertSearchOverrideWithBody(ctx context.Context, collectionName string, overrideId string, ...) (*http.Response, error)

+ func (c *Client) UpsertSearchSynonym(ctx context.Context, collectionName string, synonymId string, ...) (*http.Response, error)

+ func (c *Client) UpsertSearchSynonymWithBody(ctx context.Context, collectionName string, synonymId string, ...) (*http.Response, error)

+ func (c *Client) Vote(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ type ClientInterface interface

+ CreateCollection func(ctx context.Context, body CreateCollectionJSONRequestBody, ...) (*http.Response, error)

+ CreateCollectionWithBody func(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ CreateKey func(ctx context.Context, body CreateKeyJSONRequestBody, ...) (*http.Response, error)

+ CreateKeyWithBody func(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ Debug func(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ DeleteAlias func(ctx context.Context, aliasName string, reqEditors ...RequestEditorFn) (*http.Response, error)

+ DeleteCollection func(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*http.Response, error)

+ DeleteDocument func(ctx context.Context, collectionName string, documentId string, ...) (*http.Response, error)

+ DeleteDocuments func(ctx context.Context, collectionName string, params *DeleteDocumentsParams, ...) (*http.Response, error)

+ DeleteKey func(ctx context.Context, keyId int64, reqEditors ...RequestEditorFn) (*http.Response, error)

+ DeleteSearchOverride func(ctx context.Context, collectionName string, overrideId string, ...) (*http.Response, error)

+ DeleteSearchSynonym func(ctx context.Context, collectionName string, synonymId string, ...) (*http.Response, error)

+ ExportDocuments func(ctx context.Context, collectionName string, params *ExportDocumentsParams, ...) (*http.Response, error)

+ GetAlias func(ctx context.Context, aliasName string, reqEditors ...RequestEditorFn) (*http.Response, error)

+ GetAliases func(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ GetCollection func(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*http.Response, error)

+ GetCollections func(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ GetDocument func(ctx context.Context, collectionName string, documentId string, ...) (*http.Response, error)

+ GetKey func(ctx context.Context, keyId int64, reqEditors ...RequestEditorFn) (*http.Response, error)

+ GetKeys func(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ GetSearchOverride func(ctx context.Context, collectionName string, overrideId string, ...) (*http.Response, error)

+ GetSearchOverrides func(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*http.Response, error)

+ GetSearchSynonym func(ctx context.Context, collectionName string, synonymId string, ...) (*http.Response, error)

+ GetSearchSynonyms func(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*http.Response, error)

+ Health func(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ ImportDocumentsWithBody func(ctx context.Context, collectionName string, params *ImportDocumentsParams, ...) (*http.Response, error)

+ IndexDocument func(ctx context.Context, collectionName string, params *IndexDocumentParams, ...) (*http.Response, error)

+ IndexDocumentWithBody func(ctx context.Context, collectionName string, params *IndexDocumentParams, ...) (*http.Response, error)

+ MultiSearch func(ctx context.Context, params *MultiSearchParams, ...) (*http.Response, error)

+ MultiSearchWithBody func(ctx context.Context, params *MultiSearchParams, contentType string, ...) (*http.Response, error)

+ SearchCollection func(ctx context.Context, collectionName string, params *SearchCollectionParams, ...) (*http.Response, error)

+ TakeSnapshot func(ctx context.Context, params *TakeSnapshotParams, reqEditors ...RequestEditorFn) (*http.Response, error)

+ UpdateCollection func(ctx context.Context, collectionName string, ...) (*http.Response, error)

+ UpdateCollectionWithBody func(ctx context.Context, collectionName string, contentType string, body io.Reader, ...) (*http.Response, error)

+ UpdateDocument func(ctx context.Context, collectionName string, documentId string, ...) (*http.Response, error)

+ UpdateDocumentWithBody func(ctx context.Context, collectionName string, documentId string, ...) (*http.Response, error)

+ UpdateDocuments func(ctx context.Context, collectionName string, params *UpdateDocumentsParams, ...) (*http.Response, error)

+ UpdateDocumentsWithBody func(ctx context.Context, collectionName string, params *UpdateDocumentsParams, ...) (*http.Response, error)

+ UpsertAlias func(ctx context.Context, aliasName string, body UpsertAliasJSONRequestBody, ...) (*http.Response, error)

+ UpsertAliasWithBody func(ctx context.Context, aliasName string, contentType string, body io.Reader, ...) (*http.Response, error)

+ UpsertSearchOverride func(ctx context.Context, collectionName string, overrideId string, ...) (*http.Response, error)

+ UpsertSearchOverrideWithBody func(ctx context.Context, collectionName string, overrideId string, ...) (*http.Response, error)

+ UpsertSearchSynonym func(ctx context.Context, collectionName string, synonymId string, ...) (*http.Response, error)

+ UpsertSearchSynonymWithBody func(ctx context.Context, collectionName string, synonymId string, ...) (*http.Response, error)

+ Vote func(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ type ClientOption func(*Client) error

+ func WithAPIKey(apiKey string) ClientOption

+ func WithBaseURL(baseURL string) ClientOption

+ func WithHTTPClient(doer HttpRequestDoer) ClientOption

+ func WithRequestEditorFn(fn RequestEditorFn) ClientOption

+ type ClientWithResponses struct

+ func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

+ func (c *ClientWithResponses) CreateCollectionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateCollectionResponse, error)

+ func (c *ClientWithResponses) CreateCollectionWithResponse(ctx context.Context, body CreateCollectionJSONRequestBody, ...) (*CreateCollectionResponse, error)

+ func (c *ClientWithResponses) CreateKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateKeyResponse, error)

+ func (c *ClientWithResponses) CreateKeyWithResponse(ctx context.Context, body CreateKeyJSONRequestBody, ...) (*CreateKeyResponse, error)

+ func (c *ClientWithResponses) DebugWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*DebugResponse, error)

+ func (c *ClientWithResponses) DeleteAliasWithResponse(ctx context.Context, aliasName string, reqEditors ...RequestEditorFn) (*DeleteAliasResponse, error)

+ func (c *ClientWithResponses) DeleteCollectionWithResponse(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*DeleteCollectionResponse, error)

+ func (c *ClientWithResponses) DeleteDocumentWithResponse(ctx context.Context, collectionName string, documentId string, ...) (*DeleteDocumentResponse, error)

+ func (c *ClientWithResponses) DeleteDocumentsWithResponse(ctx context.Context, collectionName string, params *DeleteDocumentsParams, ...) (*DeleteDocumentsResponse, error)

+ func (c *ClientWithResponses) DeleteKeyWithResponse(ctx context.Context, keyId int64, reqEditors ...RequestEditorFn) (*DeleteKeyResponse, error)

+ func (c *ClientWithResponses) DeleteSearchOverrideWithResponse(ctx context.Context, collectionName string, overrideId string, ...) (*DeleteSearchOverrideResponse, error)

+ func (c *ClientWithResponses) DeleteSearchSynonymWithResponse(ctx context.Context, collectionName string, synonymId string, ...) (*DeleteSearchSynonymResponse, error)

+ func (c *ClientWithResponses) ExportDocumentsWithResponse(ctx context.Context, collectionName string, params *ExportDocumentsParams, ...) (*ExportDocumentsResponse, error)

+ func (c *ClientWithResponses) GetAliasWithResponse(ctx context.Context, aliasName string, reqEditors ...RequestEditorFn) (*GetAliasResponse, error)

+ func (c *ClientWithResponses) GetAliasesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAliasesResponse, error)

+ func (c *ClientWithResponses) GetCollectionWithResponse(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*GetCollectionResponse, error)

+ func (c *ClientWithResponses) GetCollectionsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCollectionsResponse, error)

+ func (c *ClientWithResponses) GetDocumentWithResponse(ctx context.Context, collectionName string, documentId string, ...) (*GetDocumentResponse, error)

+ func (c *ClientWithResponses) GetKeyWithResponse(ctx context.Context, keyId int64, reqEditors ...RequestEditorFn) (*GetKeyResponse, error)

+ func (c *ClientWithResponses) GetKeysWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetKeysResponse, error)

+ func (c *ClientWithResponses) GetSearchOverrideWithResponse(ctx context.Context, collectionName string, overrideId string, ...) (*GetSearchOverrideResponse, error)

+ func (c *ClientWithResponses) GetSearchOverridesWithResponse(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*GetSearchOverridesResponse, error)

+ func (c *ClientWithResponses) GetSearchSynonymWithResponse(ctx context.Context, collectionName string, synonymId string, ...) (*GetSearchSynonymResponse, error)

+ func (c *ClientWithResponses) GetSearchSynonymsWithResponse(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*GetSearchSynonymsResponse, error)

+ func (c *ClientWithResponses) HealthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthResponse, error)

+ func (c *ClientWithResponses) ImportDocumentsWithBodyWithResponse(ctx context.Context, collectionName string, params *ImportDocumentsParams, ...) (*ImportDocumentsResponse, error)

+ func (c *ClientWithResponses) IndexDocumentWithBodyWithResponse(ctx context.Context, collectionName string, params *IndexDocumentParams, ...) (*IndexDocumentResponse, error)

+ func (c *ClientWithResponses) IndexDocumentWithResponse(ctx context.Context, collectionName string, params *IndexDocumentParams, ...) (*IndexDocumentResponse, error)

+ func (c *ClientWithResponses) MultiSearchWithBodyWithResponse(ctx context.Context, params *MultiSearchParams, contentType string, ...) (*MultiSearchResponse, error)

+ func (c *ClientWithResponses) MultiSearchWithResponse(ctx context.Context, params *MultiSearchParams, ...) (*MultiSearchResponse, error)

+ func (c *ClientWithResponses) SearchCollectionWithResponse(ctx context.Context, collectionName string, params *SearchCollectionParams, ...) (*SearchCollectionResponse, error)

+ func (c *ClientWithResponses) TakeSnapshotWithResponse(ctx context.Context, params *TakeSnapshotParams, reqEditors ...RequestEditorFn) (*TakeSnapshotResponse, error)

+ func (c *ClientWithResponses) UpdateCollectionWithBodyWithResponse(ctx context.Context, collectionName string, contentType string, body io.Reader, ...) (*UpdateCollectionResponse, error)

+ func (c *ClientWithResponses) UpdateCollectionWithResponse(ctx context.Context, collectionName string, ...) (*UpdateCollectionResponse, error)

+ func (c *ClientWithResponses) UpdateDocumentWithBodyWithResponse(ctx context.Context, collectionName string, documentId string, ...) (*UpdateDocumentResponse, error)

+ func (c *ClientWithResponses) UpdateDocumentWithResponse(ctx context.Context, collectionName string, documentId string, ...) (*UpdateDocumentResponse, error)

+ func (c *ClientWithResponses) UpdateDocumentsWithBodyWithResponse(ctx context.Context, collectionName string, params *UpdateDocumentsParams, ...) (*UpdateDocumentsResponse, error)

+ func (c *ClientWithResponses) UpdateDocumentsWithResponse(ctx context.Context, collectionName string, params *UpdateDocumentsParams, ...) (*UpdateDocumentsResponse, error)

+ func (c *ClientWithResponses) UpsertAliasWithBodyWithResponse(ctx context.Context, aliasName string, contentType string, body io.Reader, ...) (*UpsertAliasResponse, error)

+ func (c *ClientWithResponses) UpsertAliasWithResponse(ctx context.Context, aliasName string, body UpsertAliasJSONRequestBody, ...) (*UpsertAliasResponse, error)

+ func (c *ClientWithResponses) UpsertSearchOverrideWithBodyWithResponse(ctx context.Context, collectionName string, overrideId string, ...) (*UpsertSearchOverrideResponse, error)

+ func (c *ClientWithResponses) UpsertSearchOverrideWithResponse(ctx context.Context, collectionName string, overrideId string, ...) (*UpsertSearchOverrideResponse, error)

+ func (c *ClientWithResponses) UpsertSearchSynonymWithBodyWithResponse(ctx context.Context, collectionName string, synonymId string, ...) (*UpsertSearchSynonymResponse, error)

+ func (c *ClientWithResponses) UpsertSearchSynonymWithResponse(ctx context.Context, collectionName string, synonymId string, ...) (*UpsertSearchSynonymResponse, error)

+ func (c *ClientWithResponses) VoteWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*VoteResponse, error)

+ type ClientWithResponsesInterface interface

+ CreateCollectionWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader, ...) (*CreateCollectionResponse, error)

+ CreateCollectionWithResponse func(ctx context.Context, body CreateCollectionJSONRequestBody, ...) (*CreateCollectionResponse, error)

+ CreateKeyWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader, ...) (*CreateKeyResponse, error)

+ CreateKeyWithResponse func(ctx context.Context, body CreateKeyJSONRequestBody, ...) (*CreateKeyResponse, error)

+ DebugWithResponse func(ctx context.Context, reqEditors ...RequestEditorFn) (*DebugResponse, error)

+ DeleteAliasWithResponse func(ctx context.Context, aliasName string, reqEditors ...RequestEditorFn) (*DeleteAliasResponse, error)

+ DeleteCollectionWithResponse func(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*DeleteCollectionResponse, error)

+ DeleteDocumentWithResponse func(ctx context.Context, collectionName string, documentId string, ...) (*DeleteDocumentResponse, error)

+ DeleteDocumentsWithResponse func(ctx context.Context, collectionName string, params *DeleteDocumentsParams, ...) (*DeleteDocumentsResponse, error)

+ DeleteKeyWithResponse func(ctx context.Context, keyId int64, reqEditors ...RequestEditorFn) (*DeleteKeyResponse, error)

+ DeleteSearchOverrideWithResponse func(ctx context.Context, collectionName string, overrideId string, ...) (*DeleteSearchOverrideResponse, error)

+ DeleteSearchSynonymWithResponse func(ctx context.Context, collectionName string, synonymId string, ...) (*DeleteSearchSynonymResponse, error)

+ ExportDocumentsWithResponse func(ctx context.Context, collectionName string, params *ExportDocumentsParams, ...) (*ExportDocumentsResponse, error)

+ GetAliasWithResponse func(ctx context.Context, aliasName string, reqEditors ...RequestEditorFn) (*GetAliasResponse, error)

+ GetAliasesWithResponse func(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAliasesResponse, error)

+ GetCollectionWithResponse func(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*GetCollectionResponse, error)

+ GetCollectionsWithResponse func(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCollectionsResponse, error)

+ GetDocumentWithResponse func(ctx context.Context, collectionName string, documentId string, ...) (*GetDocumentResponse, error)

+ GetKeyWithResponse func(ctx context.Context, keyId int64, reqEditors ...RequestEditorFn) (*GetKeyResponse, error)

+ GetKeysWithResponse func(ctx context.Context, reqEditors ...RequestEditorFn) (*GetKeysResponse, error)

+ GetSearchOverrideWithResponse func(ctx context.Context, collectionName string, overrideId string, ...) (*GetSearchOverrideResponse, error)

+ GetSearchOverridesWithResponse func(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*GetSearchOverridesResponse, error)

+ GetSearchSynonymWithResponse func(ctx context.Context, collectionName string, synonymId string, ...) (*GetSearchSynonymResponse, error)

+ GetSearchSynonymsWithResponse func(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*GetSearchSynonymsResponse, error)

+ HealthWithResponse func(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthResponse, error)

+ ImportDocumentsWithBodyWithResponse func(ctx context.Context, collectionName string, params *ImportDocumentsParams, ...) (*ImportDocumentsResponse, error)

+ IndexDocumentWithBodyWithResponse func(ctx context.Context, collectionName string, params *IndexDocumentParams, ...) (*IndexDocumentResponse, error)

+ IndexDocumentWithResponse func(ctx context.Context, collectionName string, params *IndexDocumentParams, ...) (*IndexDocumentResponse, error)

+ MultiSearchWithBodyWithResponse func(ctx context.Context, params *MultiSearchParams, contentType string, ...) (*MultiSearchResponse, error)

+ MultiSearchWithResponse func(ctx context.Context, params *MultiSearchParams, ...) (*MultiSearchResponse, error)

+ SearchCollectionWithResponse func(ctx context.Context, collectionName string, params *SearchCollectionParams, ...) (*SearchCollectionResponse, error)

+ TakeSnapshotWithResponse func(ctx context.Context, params *TakeSnapshotParams, reqEditors ...RequestEditorFn) (*TakeSnapshotResponse, error)

+ UpdateCollectionWithBodyWithResponse func(ctx context.Context, collectionName string, contentType string, body io.Reader, ...) (*UpdateCollectionResponse, error)

+ UpdateCollectionWithResponse func(ctx context.Context, collectionName string, ...) (*UpdateCollectionResponse, error)

+ UpdateDocumentWithBodyWithResponse func(ctx context.Context, collectionName string, documentId string, ...) (*UpdateDocumentResponse, error)

+ UpdateDocumentWithResponse func(ctx context.Context, collectionName string, documentId string, ...) (*UpdateDocumentResponse, error)

+ UpdateDocumentsWithBodyWithResponse func(ctx context.Context, collectionName string, params *UpdateDocumentsParams, ...) (*UpdateDocumentsResponse, error)

+ UpdateDocumentsWithResponse func(ctx context.Context, collectionName string, params *UpdateDocumentsParams, ...) (*UpdateDocumentsResponse, error)

+ UpsertAliasWithBodyWithResponse func(ctx context.Context, aliasName string, contentType string, body io.Reader, ...) (*UpsertAliasResponse, error)

+ UpsertAliasWithResponse func(ctx context.Context, aliasName string, body UpsertAliasJSONRequestBody, ...) (*UpsertAliasResponse, error)

+ UpsertSearchOverrideWithBodyWithResponse func(ctx context.Context, collectionName string, overrideId string, ...) (*UpsertSearchOverrideResponse, error)

+ UpsertSearchOverrideWithResponse func(ctx context.Context, collectionName string, overrideId string, ...) (*UpsertSearchOverrideResponse, error)

+ UpsertSearchSynonymWithBodyWithResponse func(ctx context.Context, collectionName string, synonymId string, ...) (*UpsertSearchSynonymResponse, error)

+ UpsertSearchSynonymWithResponse func(ctx context.Context, collectionName string, synonymId string, ...) (*UpsertSearchSynonymResponse, error)

+ VoteWithResponse func(ctx context.Context, reqEditors ...RequestEditorFn) (*VoteResponse, error)

+ type CollectionAlias struct

+ CollectionName string

+ Name *string

+ type CollectionAliasSchema struct

+ CollectionName string

+ type CollectionAliasesResponse struct

+ Aliases []*CollectionAlias

+ type CollectionResponse struct

+ CreatedAt *int64

+ DefaultSortingField *string

+ EnableNestedFields *bool

+ Fields []Field

+ Name string

+ NumDocuments *int64

+ SymbolsToIndex *[]string

+ TokenSeparators *[]string

+ type CollectionSchema struct

+ DefaultSortingField *string

+ EnableNestedFields *bool

+ Fields []Field

+ Name string

+ SymbolsToIndex *[]string

+ TokenSeparators *[]string

+ type CollectionUpdateSchema struct

+ Fields []Field

+ type CreateCollectionJSONRequestBody = CollectionSchema

+ type CreateCollectionResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON201 *CollectionResponse

+ JSON400 *ApiResponse

+ JSON409 *ApiResponse

+ func ParseCreateCollectionResponse(rsp *http.Response) (*CreateCollectionResponse, error)

+ func (r CreateCollectionResponse) Status() string

+ func (r CreateCollectionResponse) StatusCode() int

+ type CreateKeyJSONRequestBody = ApiKeySchema

+ type CreateKeyResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON201 *ApiKey

+ JSON400 *ApiResponse

+ JSON409 *ApiResponse

+ func ParseCreateKeyResponse(rsp *http.Response) (*CreateKeyResponse, error)

+ func (r CreateKeyResponse) Status() string

+ func (r CreateKeyResponse) StatusCode() int

+ type DebugResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 ...

+ func ParseDebugResponse(rsp *http.Response) (*DebugResponse, error)

+ func (r DebugResponse) Status() string

+ func (r DebugResponse) StatusCode() int

+ type DeleteAliasResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *CollectionAlias

+ JSON404 *ApiResponse

+ func ParseDeleteAliasResponse(rsp *http.Response) (*DeleteAliasResponse, error)

+ func (r DeleteAliasResponse) Status() string

+ func (r DeleteAliasResponse) StatusCode() int

+ type DeleteCollectionResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *CollectionResponse

+ JSON404 *ApiResponse

+ func ParseDeleteCollectionResponse(rsp *http.Response) (*DeleteCollectionResponse, error)

+ func (r DeleteCollectionResponse) Status() string

+ func (r DeleteCollectionResponse) StatusCode() int

+ type DeleteDocumentResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *map[string]interface{}

+ JSON404 *ApiResponse

+ func ParseDeleteDocumentResponse(rsp *http.Response) (*DeleteDocumentResponse, error)

+ func (r DeleteDocumentResponse) Status() string

+ func (r DeleteDocumentResponse) StatusCode() int

+ type DeleteDocumentsParams struct

+ BatchSize *int

+ FilterBy *string

+ type DeleteDocumentsResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 ...

+ JSON404 *ApiResponse

+ func ParseDeleteDocumentsResponse(rsp *http.Response) (*DeleteDocumentsResponse, error)

+ func (r DeleteDocumentsResponse) Status() string

+ func (r DeleteDocumentsResponse) StatusCode() int

+ type DeleteKeyResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *ApiKey

+ JSON400 *ApiResponse

+ JSON404 *ApiResponse

+ func ParseDeleteKeyResponse(rsp *http.Response) (*DeleteKeyResponse, error)

+ func (r DeleteKeyResponse) Status() string

+ func (r DeleteKeyResponse) StatusCode() int

+ type DeleteSearchOverrideResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *SearchOverride

+ JSON404 *ApiResponse

+ func ParseDeleteSearchOverrideResponse(rsp *http.Response) (*DeleteSearchOverrideResponse, error)

+ func (r DeleteSearchOverrideResponse) Status() string

+ func (r DeleteSearchOverrideResponse) StatusCode() int

+ type DeleteSearchSynonymResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *SearchSynonym

+ JSON404 *ApiResponse

+ func ParseDeleteSearchSynonymResponse(rsp *http.Response) (*DeleteSearchSynonymResponse, error)

+ func (r DeleteSearchSynonymResponse) Status() string

+ func (r DeleteSearchSynonymResponse) StatusCode() int

+ type ExportDocumentsParams struct

+ ExcludeFields *string

+ FilterBy *string

+ IncludeFields *string

+ type ExportDocumentsResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON404 *ApiResponse

+ func ParseExportDocumentsResponse(rsp *http.Response) (*ExportDocumentsResponse, error)

+ func (r ExportDocumentsResponse) Status() string

+ func (r ExportDocumentsResponse) StatusCode() int

+ type FacetCounts struct

+ Counts ...

+ FieldName *string

+ Stats ...

+ type Field struct

+ Drop *bool

+ Embed ...

+ Facet *bool

+ Index *bool

+ Infix *bool

+ Locale *string

+ Name string

+ NumDim *int

+ Optional *bool

+ Sort *bool

+ Type string

+ type GetAliasResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *CollectionAlias

+ JSON404 *ApiResponse

+ func ParseGetAliasResponse(rsp *http.Response) (*GetAliasResponse, error)

+ func (r GetAliasResponse) Status() string

+ func (r GetAliasResponse) StatusCode() int

+ type GetAliasesResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *CollectionAliasesResponse

+ func ParseGetAliasesResponse(rsp *http.Response) (*GetAliasesResponse, error)

+ func (r GetAliasesResponse) Status() string

+ func (r GetAliasesResponse) StatusCode() int

+ type GetCollectionResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *CollectionResponse

+ JSON404 *ApiResponse

+ func ParseGetCollectionResponse(rsp *http.Response) (*GetCollectionResponse, error)

+ func (r GetCollectionResponse) Status() string

+ func (r GetCollectionResponse) StatusCode() int

+ type GetCollectionsResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *[]*CollectionResponse

+ func ParseGetCollectionsResponse(rsp *http.Response) (*GetCollectionsResponse, error)

+ func (r GetCollectionsResponse) Status() string

+ func (r GetCollectionsResponse) StatusCode() int

+ type GetDocumentResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *map[string]interface{}

+ JSON404 *ApiResponse

+ func ParseGetDocumentResponse(rsp *http.Response) (*GetDocumentResponse, error)

+ func (r GetDocumentResponse) Status() string

+ func (r GetDocumentResponse) StatusCode() int

+ type GetKeyResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *ApiKey

+ JSON404 *ApiResponse

+ func ParseGetKeyResponse(rsp *http.Response) (*GetKeyResponse, error)

+ func (r GetKeyResponse) Status() string

+ func (r GetKeyResponse) StatusCode() int

+ type GetKeysResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *ApiKeysResponse

+ func ParseGetKeysResponse(rsp *http.Response) (*GetKeysResponse, error)

+ func (r GetKeysResponse) Status() string

+ func (r GetKeysResponse) StatusCode() int

+ type GetSearchOverrideResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *SearchOverride

+ func ParseGetSearchOverrideResponse(rsp *http.Response) (*GetSearchOverrideResponse, error)

+ func (r GetSearchOverrideResponse) Status() string

+ func (r GetSearchOverrideResponse) StatusCode() int

+ type GetSearchOverridesResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *SearchOverridesResponse

+ func ParseGetSearchOverridesResponse(rsp *http.Response) (*GetSearchOverridesResponse, error)

+ func (r GetSearchOverridesResponse) Status() string

+ func (r GetSearchOverridesResponse) StatusCode() int

+ type GetSearchSynonymResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *SearchSynonym

+ JSON404 *ApiResponse

+ func ParseGetSearchSynonymResponse(rsp *http.Response) (*GetSearchSynonymResponse, error)

+ func (r GetSearchSynonymResponse) Status() string

+ func (r GetSearchSynonymResponse) StatusCode() int

+ type GetSearchSynonymsResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *SearchSynonymsResponse

+ JSON404 *ApiResponse

+ func ParseGetSearchSynonymsResponse(rsp *http.Response) (*GetSearchSynonymsResponse, error)

+ func (r GetSearchSynonymsResponse) Status() string

+ func (r GetSearchSynonymsResponse) StatusCode() int

+ type HealthResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *HealthStatus

+ func ParseHealthResponse(rsp *http.Response) (*HealthResponse, error)

+ func (r HealthResponse) Status() string

+ func (r HealthResponse) StatusCode() int

+ type HealthStatus struct

+ Ok bool

+ type HttpRequestDoer interface

+ Do func(req *http.Request) (*http.Response, error)

+ type ImportDocumentResponse struct

+ Document string

+ Error string

+ Success bool

+ type ImportDocumentsParams struct

+ Action *string

+ BatchSize *int

+ DirtyValues *ImportDocumentsParamsDirtyValues

+ RemoteEmbeddingBatchSize *int

+ type ImportDocumentsParamsDirtyValues string

+ const CoerceOrDrop

+ const CoerceOrReject

+ const Drop

+ const Reject

+ type ImportDocumentsResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON400 *ApiResponse

+ JSON404 *ApiResponse

+ func ParseImportDocumentsResponse(rsp *http.Response) (*ImportDocumentsResponse, error)

+ func (r ImportDocumentsResponse) Status() string

+ func (r ImportDocumentsResponse) StatusCode() int

+ type IndexDocumentJSONBody = interface

+ type IndexDocumentJSONRequestBody = IndexDocumentJSONBody

+ type IndexDocumentParams struct

+ Action *IndexDocumentParamsAction

+ type IndexDocumentParamsAction string

+ const Upsert

+ type IndexDocumentResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON201 *map[string]interface{}

+ JSON404 *ApiResponse

+ func ParseIndexDocumentResponse(rsp *http.Response) (*IndexDocumentResponse, error)

+ func (r IndexDocumentResponse) Status() string

+ func (r IndexDocumentResponse) StatusCode() int

+ type MultiSearchCollectionParameters struct

+ CacheTtl *int

+ Collection string

+ DropTokensThreshold *int

+ EnableOverrides *bool

+ ExcludeFields *string

+ ExhaustiveSearch *bool

+ FacetBy *string

+ FacetQuery *string

+ FilterBy *string

+ GroupBy *string

+ GroupLimit *int

+ HiddenHits *string

+ HighlightAffixNumTokens *int

+ HighlightEndTag *string

+ HighlightFields *string

+ HighlightFullFields *string

+ HighlightStartTag *string

+ IncludeFields *string

+ Infix *string

+ MaxExtraPrefix *int

+ MaxExtraSuffix *int

+ MaxFacetValues *int

+ MinLen1typo *int

+ MinLen2typo *int

+ NumTypos *string

+ Page *int

+ PerPage *int

+ PinnedHits *string

+ PreSegmentedQuery *bool

+ Prefix *string

+ Preset *string

+ PrioritizeExactMatch *bool

+ Q *string

+ QueryBy *string

+ QueryByWeights *string

+ RemoteEmbeddingNumTries *int

+ RemoteEmbeddingTimeoutMs *int

+ SearchCutoffMs *int

+ SnippetThreshold *int

+ SortBy *string

+ TypoTokensThreshold *int

+ UseCache *bool

+ VectorQuery *string

+ type MultiSearchJSONRequestBody = MultiSearchSearchesParameter

+ type MultiSearchParameters struct

+ CacheTtl *int

+ DropTokensThreshold *int

+ EnableOverrides *bool

+ ExcludeFields *string

+ ExhaustiveSearch *bool

+ FacetBy *string

+ FacetQuery *string

+ FilterBy *string

+ GroupBy *string

+ GroupLimit *int

+ HiddenHits *string

+ HighlightAffixNumTokens *int

+ HighlightEndTag *string

+ HighlightFields *string

+ HighlightFullFields *string

+ HighlightStartTag *string

+ IncludeFields *string

+ Infix *string

+ MaxExtraPrefix *int

+ MaxExtraSuffix *int

+ MaxFacetValues *int

+ MinLen1typo *int

+ MinLen2typo *int

+ NumTypos *string

+ Page *int

+ PerPage *int

+ PinnedHits *string

+ PreSegmentedQuery *bool

+ Prefix *string

+ Preset *string

+ PrioritizeExactMatch *bool

+ Q *string

+ QueryBy *string

+ QueryByWeights *string

+ RemoteEmbeddingNumTries *int

+ RemoteEmbeddingTimeoutMs *int

+ SearchCutoffMs *int

+ SnippetThreshold *int

+ SortBy *string

+ TypoTokensThreshold *int

+ UseCache *bool

+ VectorQuery *string

+ type MultiSearchParams struct

+ CacheTtl *int

+ DropTokensThreshold *int

+ EnableHighlightV1 *bool

+ EnableOverrides *bool

+ ExcludeFields *string

+ ExhaustiveSearch *bool

+ FacetBy *string

+ FacetQuery *string

+ FilterBy *string

+ GroupBy *string

+ GroupLimit *int

+ HiddenHits *string

+ HighlightAffixNumTokens *int

+ HighlightEndTag *string

+ HighlightFields *string

+ HighlightFullFields *string

+ HighlightStartTag *string

+ IncludeFields *string

+ Infix *string

+ MaxCandidates *int

+ MaxExtraPrefix *int

+ MaxExtraSuffix *int

+ MaxFacetValues *int

+ MinLen1typo *int

+ MinLen2typo *int

+ NumTypos *string

+ Page *int

+ PerPage *int

+ PinnedHits *string

+ PreSegmentedQuery *bool

+ Prefix *string

+ Preset *string

+ PrioritizeExactMatch *bool

+ PrioritizeTokenPosition *bool

+ Q *string

+ QueryBy *string

+ QueryByWeights *string

+ RemoteEmbeddingNumTries *int

+ RemoteEmbeddingTimeoutMs *int

+ SearchCutoffMs *int

+ SnippetThreshold *int

+ SortBy *string

+ SplitJoinTokens *string

+ TypoTokensThreshold *int

+ UseCache *bool

+ VectorQuery *string

+ type MultiSearchResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *MultiSearchResult

+ JSON400 *ApiResponse

+ func ParseMultiSearchResponse(rsp *http.Response) (*MultiSearchResponse, error)

+ func (r MultiSearchResponse) Status() string

+ func (r MultiSearchResponse) StatusCode() int

+ type MultiSearchResult struct

+ Results []MultiSearchResultItem

+ type MultiSearchResultItem struct

+ Code *int

+ Error *string

+ FacetCounts *[]FacetCounts

+ Found *int

+ GroupedHits *[]SearchGroupedHit

+ Hits *[]SearchResultHit

+ OutOf *int

+ Page *int

+ RequestParams ...

+ SearchCutoff *bool

+ SearchTimeMs *int

+ type MultiSearchSearchesParameter struct

+ Searches []MultiSearchCollectionParameters

+ type RequestEditorFn func(ctx context.Context, req *http.Request) error

+ type SearchCollectionParams struct

+ CacheTtl *int

+ DropTokensThreshold *int

+ EnableHighlightV1 *bool

+ EnableOverrides *bool

+ ExcludeFields *string

+ ExhaustiveSearch *bool

+ FacetBy *string

+ FacetQuery *string

+ FilterBy *string

+ GroupBy *string

+ GroupLimit *int

+ HiddenHits *string

+ HighlightAffixNumTokens *int

+ HighlightEndTag *string

+ HighlightFields *string

+ HighlightFullFields *string

+ HighlightStartTag *string

+ IncludeFields *string

+ Infix *string

+ MaxCandidates *int

+ MaxExtraPrefix *int

+ MaxExtraSuffix *int

+ MaxFacetValues *int

+ MinLen1typo *int

+ MinLen2typo *int

+ NumTypos *string

+ Page *int

+ PerPage *int

+ PinnedHits *string

+ PreSegmentedQuery *bool

+ Prefix *string

+ Preset *string

+ PrioritizeExactMatch *bool

+ PrioritizeTokenPosition *bool

+ Q string

+ QueryBy string

+ QueryByWeights *string

+ RemoteEmbeddingNumTries *int

+ RemoteEmbeddingTimeoutMs *int

+ SearchCutoffMs *int

+ SnippetThreshold *int

+ SortBy *string

+ SplitJoinTokens *string

+ TypoTokensThreshold *int

+ UseCache *bool

+ VectorQuery *string

+ type SearchCollectionResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *SearchResult

+ JSON400 *ApiResponse

+ JSON404 *ApiResponse

+ func ParseSearchCollectionResponse(rsp *http.Response) (*SearchCollectionResponse, error)

+ func (r SearchCollectionResponse) Status() string

+ func (r SearchCollectionResponse) StatusCode() int

+ type SearchGroupedHit struct

+ GroupKey []interface{}

+ Hits []SearchResultHit

+ type SearchHighlight struct

+ Field *string

+ Indices *[]int

+ MatchedTokens *[]interface{}

+ Snippet *string

+ Snippets *[]string

+ Value *string

+ Values *[]string

+ type SearchOverride struct

+ Excludes *[]SearchOverrideExclude

+ FilterBy *string

+ Id *string

+ Includes *[]SearchOverrideInclude

+ RemoveMatchedTokens *bool

+ Rule SearchOverrideRule

+ type SearchOverrideExclude struct

+ Id string

+ type SearchOverrideInclude struct

+ Id string

+ Position int

+ type SearchOverrideRule struct

+ Match SearchOverrideRuleMatch

+ Query string

+ type SearchOverrideRuleMatch string

+ const Contains

+ const Exact

+ type SearchOverrideSchema struct

+ Excludes *[]SearchOverrideExclude

+ FilterBy *string

+ Includes *[]SearchOverrideInclude

+ RemoveMatchedTokens *bool

+ Rule SearchOverrideRule

+ type SearchOverridesResponse struct

+ Overrides []*SearchOverride

+ type SearchResult struct

+ FacetCounts *[]FacetCounts

+ Found *int

+ GroupedHits *[]SearchGroupedHit

+ Hits *[]SearchResultHit

+ OutOf *int

+ Page *int

+ RequestParams ...

+ SearchCutoff *bool

+ SearchTimeMs *int

+ type SearchResultHit struct

+ Document *map[string]interface{}

+ GeoDistanceMeters *map[string]int

+ Highlight *map[string]interface{}

+ Highlights *[]SearchHighlight

+ TextMatch *int64

+ VectorDistance *float32

+ type SearchSynonym struct

+ Id *string

+ Root *string

+ Synonyms []string

+ type SearchSynonymSchema struct

+ Root *string

+ Synonyms []string

+ type SearchSynonymsResponse struct

+ Synonyms []*SearchSynonym

+ type SuccessStatus struct

+ Success bool

+ type TakeSnapshotParams struct

+ SnapshotPath string

+ type TakeSnapshotResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON201 *SuccessStatus

+ func ParseTakeSnapshotResponse(rsp *http.Response) (*TakeSnapshotResponse, error)

+ func (r TakeSnapshotResponse) Status() string

+ func (r TakeSnapshotResponse) StatusCode() int

+ type UpdateCollectionJSONRequestBody = CollectionUpdateSchema

+ type UpdateCollectionResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *CollectionUpdateSchema

+ JSON400 *ApiResponse

+ JSON404 *ApiResponse

+ func ParseUpdateCollectionResponse(rsp *http.Response) (*UpdateCollectionResponse, error)

+ func (r UpdateCollectionResponse) Status() string

+ func (r UpdateCollectionResponse) StatusCode() int

+ type UpdateDocumentJSONBody = interface

+ type UpdateDocumentJSONRequestBody = UpdateDocumentJSONBody

+ type UpdateDocumentResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *map[string]interface{}

+ JSON404 *ApiResponse

+ func ParseUpdateDocumentResponse(rsp *http.Response) (*UpdateDocumentResponse, error)

+ func (r UpdateDocumentResponse) Status() string

+ func (r UpdateDocumentResponse) StatusCode() int

+ type UpdateDocumentsJSONBody = interface

+ type UpdateDocumentsJSONRequestBody = UpdateDocumentsJSONBody

+ type UpdateDocumentsParams struct

+ FilterBy *string

+ type UpdateDocumentsResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 ...

+ JSON400 *ApiResponse

+ JSON404 *ApiResponse

+ func ParseUpdateDocumentsResponse(rsp *http.Response) (*UpdateDocumentsResponse, error)

+ func (r UpdateDocumentsResponse) Status() string

+ func (r UpdateDocumentsResponse) StatusCode() int

+ type UpsertAliasJSONRequestBody = CollectionAliasSchema

+ type UpsertAliasResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *CollectionAlias

+ JSON400 *ApiResponse

+ JSON404 *ApiResponse

+ func ParseUpsertAliasResponse(rsp *http.Response) (*UpsertAliasResponse, error)

+ func (r UpsertAliasResponse) Status() string

+ func (r UpsertAliasResponse) StatusCode() int

+ type UpsertSearchOverrideJSONRequestBody = SearchOverrideSchema

+ type UpsertSearchOverrideResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *SearchOverride

+ JSON404 *ApiResponse

+ func ParseUpsertSearchOverrideResponse(rsp *http.Response) (*UpsertSearchOverrideResponse, error)

+ func (r UpsertSearchOverrideResponse) Status() string

+ func (r UpsertSearchOverrideResponse) StatusCode() int

+ type UpsertSearchSynonymJSONRequestBody = SearchSynonymSchema

+ type UpsertSearchSynonymResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *SearchSynonym

+ JSON404 *ApiResponse

+ func ParseUpsertSearchSynonymResponse(rsp *http.Response) (*UpsertSearchSynonymResponse, error)

+ func (r UpsertSearchSynonymResponse) Status() string

+ func (r UpsertSearchSynonymResponse) StatusCode() int

+ type VoteResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *SuccessStatus

+ func ParseVoteResponse(rsp *http.Response) (*VoteResponse, error)

+ func (r VoteResponse) Status() string

+ func (r VoteResponse) StatusCode() int

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL