Documentation
¶
Overview ¶
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.
Index ¶
- Constants
- func NewCreateAnalyticsEventRequest(server string, body CreateAnalyticsEventJSONRequestBody) (*http.Request, error)
- func NewCreateAnalyticsEventRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewCreateAnalyticsRuleRequest(server string, body CreateAnalyticsRuleJSONRequestBody) (*http.Request, error)
- func NewCreateAnalyticsRuleRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewCreateCollectionRequest(server string, body CreateCollectionJSONRequestBody) (*http.Request, error)
- func NewCreateCollectionRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewCreateConversationModelRequest(server string, body CreateConversationModelJSONRequestBody) (*http.Request, error)
- func NewCreateConversationModelRequestWithBody(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 NewDeleteAnalyticsRuleRequest(server string, ruleName string) (*http.Request, error)
- func NewDeleteCollectionRequest(server string, collectionName string) (*http.Request, error)
- func NewDeleteConversationModelRequest(server string, modelId 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 NewDeletePresetRequest(server string, presetId string) (*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 NewDeleteStopwordsSetRequest(server string, setId 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 NewGetSchemaChangesRequest(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 NewGetStemmingDictionaryRequest(server string, dictionaryId string) (*http.Request, error)
- func NewHealthRequest(server string) (*http.Request, error)
- func NewImportDocumentsRequestWithBody(server string, collectionName string, params *ImportDocumentsParams, ...) (*http.Request, error)
- func NewImportStemmingDictionaryRequest(server string, params *ImportStemmingDictionaryParams, ...) (*http.Request, error)
- func NewImportStemmingDictionaryRequestWithBody(server string, params *ImportStemmingDictionaryParams, contentType string, ...) (*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 NewListStemmingDictionariesRequest(server string) (*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 NewRetrieveAPIStatsRequest(server string) (*http.Request, error)
- func NewRetrieveAllConversationModelsRequest(server string) (*http.Request, error)
- func NewRetrieveAllPresetsRequest(server string) (*http.Request, error)
- func NewRetrieveAnalyticsRuleRequest(server string, ruleName string) (*http.Request, error)
- func NewRetrieveAnalyticsRulesRequest(server string) (*http.Request, error)
- func NewRetrieveConversationModelRequest(server string, modelId string) (*http.Request, error)
- func NewRetrieveMetricsRequest(server string) (*http.Request, error)
- func NewRetrievePresetRequest(server string, presetId string) (*http.Request, error)
- func NewRetrieveStopwordsSetRequest(server string, setId string) (*http.Request, error)
- func NewRetrieveStopwordsSetsRequest(server string) (*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 NewUpdateConversationModelRequest(server string, modelId string, body UpdateConversationModelJSONRequestBody) (*http.Request, error)
- func NewUpdateConversationModelRequestWithBody(server string, modelId 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, ...) (*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 NewUpsertAnalyticsRuleRequest(server string, ruleName string, body UpsertAnalyticsRuleJSONRequestBody) (*http.Request, error)
- func NewUpsertAnalyticsRuleRequestWithBody(server string, ruleName string, contentType string, body io.Reader) (*http.Request, error)
- func NewUpsertPresetRequest(server string, presetId string, body UpsertPresetJSONRequestBody) (*http.Request, error)
- func NewUpsertPresetRequestWithBody(server string, presetId 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 NewUpsertStopwordsSetRequest(server string, setId string, body UpsertStopwordsSetJSONRequestBody) (*http.Request, error)
- func NewUpsertStopwordsSetRequestWithBody(server string, setId string, contentType string, body io.Reader) (*http.Request, error)
- func NewVoteRequest(server string) (*http.Request, error)
- type APIStatsResponse
- type AnalyticsEventCreateResponse
- type AnalyticsEventCreateSchema
- type AnalyticsRuleDeleteResponse
- type AnalyticsRuleParameters
- type AnalyticsRuleParametersDestination
- type AnalyticsRuleParametersSource
- type AnalyticsRuleSchema
- type AnalyticsRuleSchemaType
- type AnalyticsRuleUpsertSchema
- type AnalyticsRuleUpsertSchemaType
- type AnalyticsRulesRetrieveSchema
- type ApiKey
- type ApiKeyDeleteResponse
- type ApiKeySchema
- type ApiKeysResponse
- type ApiResponse
- type Client
- func (c *Client) CreateAnalyticsEvent(ctx context.Context, body CreateAnalyticsEventJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) CreateAnalyticsEventWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) CreateAnalyticsRule(ctx context.Context, body CreateAnalyticsRuleJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) CreateAnalyticsRuleWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, 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) CreateConversationModel(ctx context.Context, body CreateConversationModelJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) CreateConversationModelWithBody(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) DeleteAnalyticsRule(ctx context.Context, ruleName string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) DeleteCollection(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) DeleteConversationModel(ctx context.Context, modelId 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) DeletePreset(ctx context.Context, presetId string, 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) DeleteStopwordsSet(ctx context.Context, setId string, reqEditors ...RequestEditorFn) (*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) GetSchemaChanges(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) GetStemmingDictionary(ctx context.Context, dictionaryId 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) ImportStemmingDictionary(ctx context.Context, params *ImportStemmingDictionaryParams, ...) (*http.Response, error)
- func (c *Client) ImportStemmingDictionaryWithBody(ctx context.Context, params *ImportStemmingDictionaryParams, ...) (*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) ListStemmingDictionaries(ctx context.Context, reqEditors ...RequestEditorFn) (*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) RetrieveAPIStats(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) RetrieveAllConversationModels(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) RetrieveAllPresets(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) RetrieveAnalyticsRule(ctx context.Context, ruleName string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) RetrieveAnalyticsRules(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) RetrieveConversationModel(ctx context.Context, modelId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) RetrieveMetrics(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) RetrievePreset(ctx context.Context, presetId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) RetrieveStopwordsSet(ctx context.Context, setId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) RetrieveStopwordsSets(ctx context.Context, reqEditors ...RequestEditorFn) (*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) UpdateConversationModel(ctx context.Context, modelId string, ...) (*http.Response, error)
- func (c *Client) UpdateConversationModelWithBody(ctx context.Context, modelId 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) UpsertAnalyticsRule(ctx context.Context, ruleName string, body UpsertAnalyticsRuleJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UpsertAnalyticsRuleWithBody(ctx context.Context, ruleName string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) UpsertPreset(ctx context.Context, presetId string, body UpsertPresetJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UpsertPresetWithBody(ctx context.Context, presetId 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) UpsertStopwordsSet(ctx context.Context, setId string, body UpsertStopwordsSetJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UpsertStopwordsSetWithBody(ctx context.Context, setId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) Vote(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) CreateAnalyticsEventWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateAnalyticsEventResponse, error)
- func (c *ClientWithResponses) CreateAnalyticsEventWithResponse(ctx context.Context, body CreateAnalyticsEventJSONRequestBody, ...) (*CreateAnalyticsEventResponse, error)
- func (c *ClientWithResponses) CreateAnalyticsRuleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateAnalyticsRuleResponse, error)
- func (c *ClientWithResponses) CreateAnalyticsRuleWithResponse(ctx context.Context, body CreateAnalyticsRuleJSONRequestBody, ...) (*CreateAnalyticsRuleResponse, 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) CreateConversationModelWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateConversationModelResponse, error)
- func (c *ClientWithResponses) CreateConversationModelWithResponse(ctx context.Context, body CreateConversationModelJSONRequestBody, ...) (*CreateConversationModelResponse, 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) DeleteAnalyticsRuleWithResponse(ctx context.Context, ruleName string, reqEditors ...RequestEditorFn) (*DeleteAnalyticsRuleResponse, error)
- func (c *ClientWithResponses) DeleteCollectionWithResponse(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*DeleteCollectionResponse, error)
- func (c *ClientWithResponses) DeleteConversationModelWithResponse(ctx context.Context, modelId string, reqEditors ...RequestEditorFn) (*DeleteConversationModelResponse, 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) DeletePresetWithResponse(ctx context.Context, presetId string, reqEditors ...RequestEditorFn) (*DeletePresetResponse, 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) DeleteStopwordsSetWithResponse(ctx context.Context, setId string, reqEditors ...RequestEditorFn) (*DeleteStopwordsSetResponse, 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) GetSchemaChangesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSchemaChangesResponse, 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) GetStemmingDictionaryWithResponse(ctx context.Context, dictionaryId string, reqEditors ...RequestEditorFn) (*GetStemmingDictionaryResponse, 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) ImportStemmingDictionaryWithBodyWithResponse(ctx context.Context, params *ImportStemmingDictionaryParams, ...) (*ImportStemmingDictionaryResponse, error)
- func (c *ClientWithResponses) ImportStemmingDictionaryWithResponse(ctx context.Context, params *ImportStemmingDictionaryParams, ...) (*ImportStemmingDictionaryResponse, 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) ListStemmingDictionariesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListStemmingDictionariesResponse, 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) RetrieveAPIStatsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveAPIStatsResponse, error)
- func (c *ClientWithResponses) RetrieveAllConversationModelsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveAllConversationModelsResponse, error)
- func (c *ClientWithResponses) RetrieveAllPresetsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveAllPresetsResponse, error)
- func (c *ClientWithResponses) RetrieveAnalyticsRuleWithResponse(ctx context.Context, ruleName string, reqEditors ...RequestEditorFn) (*RetrieveAnalyticsRuleResponse, error)
- func (c *ClientWithResponses) RetrieveAnalyticsRulesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveAnalyticsRulesResponse, error)
- func (c *ClientWithResponses) RetrieveConversationModelWithResponse(ctx context.Context, modelId string, reqEditors ...RequestEditorFn) (*RetrieveConversationModelResponse, error)
- func (c *ClientWithResponses) RetrieveMetricsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveMetricsResponse, error)
- func (c *ClientWithResponses) RetrievePresetWithResponse(ctx context.Context, presetId string, reqEditors ...RequestEditorFn) (*RetrievePresetResponse, error)
- func (c *ClientWithResponses) RetrieveStopwordsSetWithResponse(ctx context.Context, setId string, reqEditors ...RequestEditorFn) (*RetrieveStopwordsSetResponse, error)
- func (c *ClientWithResponses) RetrieveStopwordsSetsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveStopwordsSetsResponse, 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) UpdateConversationModelWithBodyWithResponse(ctx context.Context, modelId string, contentType string, body io.Reader, ...) (*UpdateConversationModelResponse, error)
- func (c *ClientWithResponses) UpdateConversationModelWithResponse(ctx context.Context, modelId string, ...) (*UpdateConversationModelResponse, 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) UpsertAnalyticsRuleWithBodyWithResponse(ctx context.Context, ruleName string, contentType string, body io.Reader, ...) (*UpsertAnalyticsRuleResponse, error)
- func (c *ClientWithResponses) UpsertAnalyticsRuleWithResponse(ctx context.Context, ruleName string, body UpsertAnalyticsRuleJSONRequestBody, ...) (*UpsertAnalyticsRuleResponse, error)
- func (c *ClientWithResponses) UpsertPresetWithBodyWithResponse(ctx context.Context, presetId string, contentType string, body io.Reader, ...) (*UpsertPresetResponse, error)
- func (c *ClientWithResponses) UpsertPresetWithResponse(ctx context.Context, presetId string, body UpsertPresetJSONRequestBody, ...) (*UpsertPresetResponse, 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) UpsertStopwordsSetWithBodyWithResponse(ctx context.Context, setId string, contentType string, body io.Reader, ...) (*UpsertStopwordsSetResponse, error)
- func (c *ClientWithResponses) UpsertStopwordsSetWithResponse(ctx context.Context, setId string, body UpsertStopwordsSetJSONRequestBody, ...) (*UpsertStopwordsSetResponse, error)
- func (c *ClientWithResponses) VoteWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*VoteResponse, error)
- type ClientWithResponsesInterface
- type CollectionAlias
- type CollectionAliasSchema
- type CollectionAliasesResponse
- type CollectionResponse
- type CollectionSchema
- type CollectionUpdateSchema
- type ConversationModelCreateSchema
- type ConversationModelSchema
- type ConversationModelUpdateSchema
- type CreateAnalyticsEventJSONRequestBody
- type CreateAnalyticsEventResponse
- type CreateAnalyticsRuleJSONRequestBody
- type CreateAnalyticsRuleResponse
- type CreateCollectionJSONRequestBody
- type CreateCollectionResponse
- type CreateConversationModelJSONRequestBody
- type CreateConversationModelResponse
- type CreateKeyJSONRequestBody
- type CreateKeyResponse
- type DebugResponse
- type DeleteAliasResponse
- type DeleteAnalyticsRuleResponse
- type DeleteCollectionResponse
- type DeleteConversationModelResponse
- type DeleteDocumentResponse
- type DeleteDocumentsParams
- type DeleteDocumentsResponse
- type DeleteKeyResponse
- type DeletePresetResponse
- type DeleteSearchOverrideResponse
- type DeleteSearchSynonymResponse
- type DeleteStopwordsSetResponse
- type DirtyValues
- type DocumentIndexParameters
- type DropTokensMode
- type ExportDocumentsParams
- type ExportDocumentsResponse
- type FacetCounts
- type Field
- type GetAliasResponse
- type GetAliasesResponse
- type GetCollectionResponse
- type GetCollectionsResponse
- type GetDocumentResponse
- type GetKeyResponse
- type GetKeysResponse
- type GetSchemaChangesResponse
- type GetSearchOverrideResponse
- type GetSearchOverridesResponse
- type GetSearchSynonymResponse
- type GetSearchSynonymsResponse
- type GetStemmingDictionaryResponse
- type HealthResponse
- type HealthStatus
- type HttpRequestDoer
- type ImportDocumentResponse
- type ImportDocumentsParams
- type ImportDocumentsResponse
- type ImportStemmingDictionaryJSONBody
- type ImportStemmingDictionaryJSONRequestBody
- type ImportStemmingDictionaryParams
- type ImportStemmingDictionaryResponse
- type IndexAction
- type IndexDocumentJSONBody
- type IndexDocumentJSONRequestBody
- type IndexDocumentParams
- type IndexDocumentResponse
- type ListStemmingDictionariesResponse
- type MultiSearchCollectionParameters
- type MultiSearchJSONRequestBody
- type MultiSearchParameters
- type MultiSearchParams
- type MultiSearchResponse
- type MultiSearchResult
- type MultiSearchResultItem
- type MultiSearchSearchesParameter
- type PresetDeleteSchema
- type PresetSchema
- type PresetSchema_Value
- func (t PresetSchema_Value) AsMultiSearchSearchesParameter() (MultiSearchSearchesParameter, error)
- func (t PresetSchema_Value) AsSearchParameters() (SearchParameters, error)
- func (t *PresetSchema_Value) FromMultiSearchSearchesParameter(v MultiSearchSearchesParameter) error
- func (t *PresetSchema_Value) FromSearchParameters(v SearchParameters) error
- func (t PresetSchema_Value) MarshalJSON() ([]byte, error)
- func (t *PresetSchema_Value) MergeMultiSearchSearchesParameter(v MultiSearchSearchesParameter) error
- func (t *PresetSchema_Value) MergeSearchParameters(v SearchParameters) error
- func (t *PresetSchema_Value) UnmarshalJSON(b []byte) error
- type PresetUpsertSchema
- type PresetUpsertSchema_Value
- func (t PresetUpsertSchema_Value) AsMultiSearchSearchesParameter() (MultiSearchSearchesParameter, error)
- func (t PresetUpsertSchema_Value) AsSearchParameters() (SearchParameters, error)
- func (t *PresetUpsertSchema_Value) FromMultiSearchSearchesParameter(v MultiSearchSearchesParameter) error
- func (t *PresetUpsertSchema_Value) FromSearchParameters(v SearchParameters) error
- func (t PresetUpsertSchema_Value) MarshalJSON() ([]byte, error)
- func (t *PresetUpsertSchema_Value) MergeMultiSearchSearchesParameter(v MultiSearchSearchesParameter) error
- func (t *PresetUpsertSchema_Value) MergeSearchParameters(v SearchParameters) error
- func (t *PresetUpsertSchema_Value) UnmarshalJSON(b []byte) error
- type PresetsRetrieveSchema
- type RequestEditorFn
- type RetrieveAPIStatsResponse
- type RetrieveAllConversationModelsResponse
- type RetrieveAllPresetsResponse
- type RetrieveAnalyticsRuleResponse
- type RetrieveAnalyticsRulesResponse
- type RetrieveConversationModelResponse
- type RetrieveMetricsResponse
- type RetrievePresetResponse
- type RetrieveStopwordsSetResponse
- type RetrieveStopwordsSetsResponse
- type SchemaChangeStatus
- type SearchCollectionParams
- type SearchCollectionResponse
- type SearchGroupedHit
- type SearchHighlight
- type SearchOverride
- type SearchOverrideDeleteResponse
- type SearchOverrideExclude
- type SearchOverrideInclude
- type SearchOverrideRule
- type SearchOverrideRuleMatch
- type SearchOverrideSchema
- type SearchOverridesResponse
- type SearchParameters
- type SearchResult
- type SearchResultConversation
- type SearchResultHit
- type SearchSynonym
- type SearchSynonymDeleteResponse
- type SearchSynonymSchema
- type SearchSynonymsResponse
- type StemmingDictionary
- type StemmingDictionaryWord
- type StopwordsSetRetrieveSchema
- type StopwordsSetSchema
- type StopwordsSetUpsertSchema
- type StopwordsSetsRetrieveAllSchema
- type SuccessStatus
- type TakeSnapshotParams
- type TakeSnapshotResponse
- type UpdateCollectionJSONRequestBody
- type UpdateCollectionResponse
- type UpdateConversationModelJSONRequestBody
- type UpdateConversationModelResponse
- type UpdateDocumentJSONBody
- type UpdateDocumentJSONRequestBody
- type UpdateDocumentParams
- type UpdateDocumentResponse
- type UpdateDocumentsJSONBody
- type UpdateDocumentsJSONRequestBody
- type UpdateDocumentsParams
- type UpdateDocumentsResponse
- type UpsertAliasJSONRequestBody
- type UpsertAliasResponse
- type UpsertAnalyticsRuleJSONRequestBody
- type UpsertAnalyticsRuleResponse
- type UpsertPresetJSONRequestBody
- type UpsertPresetResponse
- type UpsertSearchOverrideJSONRequestBody
- type UpsertSearchOverrideResponse
- type UpsertSearchSynonymJSONRequestBody
- type UpsertSearchSynonymResponse
- type UpsertStopwordsSetJSONRequestBody
- type UpsertStopwordsSetResponse
- type VoiceQueryModelCollectionConfig
- type VoteResponse
Constants ¶
const APIKeyHeader = "X-TYPESENSE-API-KEY" // #nosec G101
const (
Api_key_headerScopes = "api_key_header.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func NewCreateAnalyticsEventRequest ¶
func NewCreateAnalyticsEventRequest(server string, body CreateAnalyticsEventJSONRequestBody) (*http.Request, error)
NewCreateAnalyticsEventRequest calls the generic CreateAnalyticsEvent builder with application/json body
func NewCreateAnalyticsEventRequestWithBody ¶
func NewCreateAnalyticsEventRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCreateAnalyticsEventRequestWithBody generates requests for CreateAnalyticsEvent with any type of body
func NewCreateAnalyticsRuleRequest ¶
func NewCreateAnalyticsRuleRequest(server string, body CreateAnalyticsRuleJSONRequestBody) (*http.Request, error)
NewCreateAnalyticsRuleRequest calls the generic CreateAnalyticsRule builder with application/json body
func NewCreateAnalyticsRuleRequestWithBody ¶
func NewCreateAnalyticsRuleRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCreateAnalyticsRuleRequestWithBody generates requests for CreateAnalyticsRule with any type of body
func NewCreateCollectionRequest ¶
func NewCreateCollectionRequest(server string, body CreateCollectionJSONRequestBody) (*http.Request, error)
NewCreateCollectionRequest calls the generic CreateCollection builder with application/json body
func NewCreateCollectionRequestWithBody ¶
func NewCreateCollectionRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCreateCollectionRequestWithBody generates requests for CreateCollection with any type of body
func NewCreateConversationModelRequest ¶
func NewCreateConversationModelRequest(server string, body CreateConversationModelJSONRequestBody) (*http.Request, error)
NewCreateConversationModelRequest calls the generic CreateConversationModel builder with application/json body
func NewCreateConversationModelRequestWithBody ¶
func NewCreateConversationModelRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCreateConversationModelRequestWithBody generates requests for CreateConversationModel with any type of body
func NewCreateKeyRequest ¶
func NewCreateKeyRequest(server string, body CreateKeyJSONRequestBody) (*http.Request, error)
NewCreateKeyRequest calls the generic CreateKey builder with application/json body
func NewCreateKeyRequestWithBody ¶
func NewCreateKeyRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCreateKeyRequestWithBody generates requests for CreateKey with any type of body
func NewDebugRequest ¶
NewDebugRequest generates requests for Debug
func NewDeleteAliasRequest ¶
NewDeleteAliasRequest generates requests for DeleteAlias
func NewDeleteAnalyticsRuleRequest ¶
NewDeleteAnalyticsRuleRequest generates requests for DeleteAnalyticsRule
func NewDeleteCollectionRequest ¶
NewDeleteCollectionRequest generates requests for DeleteCollection
func NewDeleteConversationModelRequest ¶
NewDeleteConversationModelRequest generates requests for DeleteConversationModel
func NewDeleteDocumentRequest ¶
func NewDeleteDocumentRequest(server string, collectionName string, documentId string) (*http.Request, error)
NewDeleteDocumentRequest generates requests for DeleteDocument
func NewDeleteDocumentsRequest ¶
func NewDeleteDocumentsRequest(server string, collectionName string, params *DeleteDocumentsParams) (*http.Request, error)
NewDeleteDocumentsRequest generates requests for DeleteDocuments
func NewDeleteKeyRequest ¶
NewDeleteKeyRequest generates requests for DeleteKey
func NewDeletePresetRequest ¶
NewDeletePresetRequest generates requests for DeletePreset
func NewDeleteSearchOverrideRequest ¶
func NewDeleteSearchOverrideRequest(server string, collectionName string, overrideId string) (*http.Request, error)
NewDeleteSearchOverrideRequest generates requests for DeleteSearchOverride
func NewDeleteSearchSynonymRequest ¶
func NewDeleteSearchSynonymRequest(server string, collectionName string, synonymId string) (*http.Request, error)
NewDeleteSearchSynonymRequest generates requests for DeleteSearchSynonym
func NewDeleteStopwordsSetRequest ¶
NewDeleteStopwordsSetRequest generates requests for DeleteStopwordsSet
func NewExportDocumentsRequest ¶
func NewExportDocumentsRequest(server string, collectionName string, params *ExportDocumentsParams) (*http.Request, error)
NewExportDocumentsRequest generates requests for ExportDocuments
func NewGetAliasRequest ¶
NewGetAliasRequest generates requests for GetAlias
func NewGetAliasesRequest ¶
NewGetAliasesRequest generates requests for GetAliases
func NewGetCollectionRequest ¶
NewGetCollectionRequest generates requests for GetCollection
func NewGetCollectionsRequest ¶
NewGetCollectionsRequest generates requests for GetCollections
func NewGetDocumentRequest ¶
func NewGetDocumentRequest(server string, collectionName string, documentId string) (*http.Request, error)
NewGetDocumentRequest generates requests for GetDocument
func NewGetKeyRequest ¶
NewGetKeyRequest generates requests for GetKey
func NewGetKeysRequest ¶
NewGetKeysRequest generates requests for GetKeys
func NewGetSchemaChangesRequest ¶
NewGetSchemaChangesRequest generates requests for GetSchemaChanges
func NewGetSearchOverrideRequest ¶
func NewGetSearchOverrideRequest(server string, collectionName string, overrideId string) (*http.Request, error)
NewGetSearchOverrideRequest generates requests for GetSearchOverride
func NewGetSearchOverridesRequest ¶
NewGetSearchOverridesRequest generates requests for GetSearchOverrides
func NewGetSearchSynonymRequest ¶
func NewGetSearchSynonymRequest(server string, collectionName string, synonymId string) (*http.Request, error)
NewGetSearchSynonymRequest generates requests for GetSearchSynonym
func NewGetSearchSynonymsRequest ¶
NewGetSearchSynonymsRequest generates requests for GetSearchSynonyms
func NewGetStemmingDictionaryRequest ¶
NewGetStemmingDictionaryRequest generates requests for GetStemmingDictionary
func NewHealthRequest ¶
NewHealthRequest generates requests for Health
func NewImportDocumentsRequestWithBody ¶
func NewImportDocumentsRequestWithBody(server string, collectionName string, params *ImportDocumentsParams, contentType string, body io.Reader) (*http.Request, error)
NewImportDocumentsRequestWithBody generates requests for ImportDocuments with any type of body
func NewImportStemmingDictionaryRequest ¶
func NewImportStemmingDictionaryRequest(server string, params *ImportStemmingDictionaryParams, body ImportStemmingDictionaryJSONRequestBody) (*http.Request, error)
NewImportStemmingDictionaryRequest calls the generic ImportStemmingDictionary builder with application/json body
func NewImportStemmingDictionaryRequestWithBody ¶
func NewImportStemmingDictionaryRequestWithBody(server string, params *ImportStemmingDictionaryParams, contentType string, body io.Reader) (*http.Request, error)
NewImportStemmingDictionaryRequestWithBody generates requests for ImportStemmingDictionary with any type of body
func NewIndexDocumentRequest ¶
func NewIndexDocumentRequest(server string, collectionName string, params *IndexDocumentParams, body IndexDocumentJSONRequestBody) (*http.Request, error)
NewIndexDocumentRequest calls the generic IndexDocument builder with application/json body
func NewIndexDocumentRequestWithBody ¶
func NewIndexDocumentRequestWithBody(server string, collectionName string, params *IndexDocumentParams, contentType string, body io.Reader) (*http.Request, error)
NewIndexDocumentRequestWithBody generates requests for IndexDocument with any type of body
func NewListStemmingDictionariesRequest ¶
NewListStemmingDictionariesRequest generates requests for ListStemmingDictionaries
func NewMultiSearchRequest ¶
func NewMultiSearchRequest(server string, params *MultiSearchParams, body MultiSearchJSONRequestBody) (*http.Request, error)
NewMultiSearchRequest calls the generic MultiSearch builder with application/json body
func NewMultiSearchRequestWithBody ¶
func NewMultiSearchRequestWithBody(server string, params *MultiSearchParams, contentType string, body io.Reader) (*http.Request, error)
NewMultiSearchRequestWithBody generates requests for MultiSearch with any type of body
func NewRetrieveAPIStatsRequest ¶
NewRetrieveAPIStatsRequest generates requests for RetrieveAPIStats
func NewRetrieveAllConversationModelsRequest ¶
NewRetrieveAllConversationModelsRequest generates requests for RetrieveAllConversationModels
func NewRetrieveAllPresetsRequest ¶
NewRetrieveAllPresetsRequest generates requests for RetrieveAllPresets
func NewRetrieveAnalyticsRuleRequest ¶
NewRetrieveAnalyticsRuleRequest generates requests for RetrieveAnalyticsRule
func NewRetrieveAnalyticsRulesRequest ¶
NewRetrieveAnalyticsRulesRequest generates requests for RetrieveAnalyticsRules
func NewRetrieveConversationModelRequest ¶
NewRetrieveConversationModelRequest generates requests for RetrieveConversationModel
func NewRetrieveMetricsRequest ¶
NewRetrieveMetricsRequest generates requests for RetrieveMetrics
func NewRetrievePresetRequest ¶
NewRetrievePresetRequest generates requests for RetrievePreset
func NewRetrieveStopwordsSetRequest ¶
NewRetrieveStopwordsSetRequest generates requests for RetrieveStopwordsSet
func NewRetrieveStopwordsSetsRequest ¶
NewRetrieveStopwordsSetsRequest generates requests for RetrieveStopwordsSets
func NewSearchCollectionRequest ¶
func NewSearchCollectionRequest(server string, collectionName string, params *SearchCollectionParams) (*http.Request, error)
NewSearchCollectionRequest generates requests for SearchCollection
func NewTakeSnapshotRequest ¶
func NewTakeSnapshotRequest(server string, params *TakeSnapshotParams) (*http.Request, error)
NewTakeSnapshotRequest generates requests for TakeSnapshot
func NewUpdateCollectionRequest ¶
func NewUpdateCollectionRequest(server string, collectionName string, body UpdateCollectionJSONRequestBody) (*http.Request, error)
NewUpdateCollectionRequest calls the generic UpdateCollection builder with application/json body
func NewUpdateCollectionRequestWithBody ¶
func NewUpdateCollectionRequestWithBody(server string, collectionName string, contentType string, body io.Reader) (*http.Request, error)
NewUpdateCollectionRequestWithBody generates requests for UpdateCollection with any type of body
func NewUpdateConversationModelRequest ¶
func NewUpdateConversationModelRequest(server string, modelId string, body UpdateConversationModelJSONRequestBody) (*http.Request, error)
NewUpdateConversationModelRequest calls the generic UpdateConversationModel builder with application/json body
func NewUpdateConversationModelRequestWithBody ¶
func NewUpdateConversationModelRequestWithBody(server string, modelId string, contentType string, body io.Reader) (*http.Request, error)
NewUpdateConversationModelRequestWithBody generates requests for UpdateConversationModel with any type of body
func NewUpdateDocumentRequest ¶
func NewUpdateDocumentRequest(server string, collectionName string, documentId string, params *UpdateDocumentParams, body UpdateDocumentJSONRequestBody) (*http.Request, error)
NewUpdateDocumentRequest calls the generic UpdateDocument builder with application/json body
func NewUpdateDocumentRequestWithBody ¶
func NewUpdateDocumentRequestWithBody(server string, collectionName string, documentId string, params *UpdateDocumentParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateDocumentRequestWithBody generates requests for UpdateDocument with any type of body
func NewUpdateDocumentsRequest ¶
func NewUpdateDocumentsRequest(server string, collectionName string, params *UpdateDocumentsParams, body UpdateDocumentsJSONRequestBody) (*http.Request, error)
NewUpdateDocumentsRequest calls the generic UpdateDocuments builder with application/json body
func NewUpdateDocumentsRequestWithBody ¶
func NewUpdateDocumentsRequestWithBody(server string, collectionName string, params *UpdateDocumentsParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateDocumentsRequestWithBody generates requests for UpdateDocuments with any type of body
func NewUpsertAliasRequest ¶
func NewUpsertAliasRequest(server string, aliasName string, body UpsertAliasJSONRequestBody) (*http.Request, error)
NewUpsertAliasRequest calls the generic UpsertAlias builder with application/json body
func NewUpsertAliasRequestWithBody ¶
func NewUpsertAliasRequestWithBody(server string, aliasName string, contentType string, body io.Reader) (*http.Request, error)
NewUpsertAliasRequestWithBody generates requests for UpsertAlias with any type of body
func NewUpsertAnalyticsRuleRequest ¶
func NewUpsertAnalyticsRuleRequest(server string, ruleName string, body UpsertAnalyticsRuleJSONRequestBody) (*http.Request, error)
NewUpsertAnalyticsRuleRequest calls the generic UpsertAnalyticsRule builder with application/json body
func NewUpsertAnalyticsRuleRequestWithBody ¶
func NewUpsertAnalyticsRuleRequestWithBody(server string, ruleName string, contentType string, body io.Reader) (*http.Request, error)
NewUpsertAnalyticsRuleRequestWithBody generates requests for UpsertAnalyticsRule with any type of body
func NewUpsertPresetRequest ¶
func NewUpsertPresetRequest(server string, presetId string, body UpsertPresetJSONRequestBody) (*http.Request, error)
NewUpsertPresetRequest calls the generic UpsertPreset builder with application/json body
func NewUpsertPresetRequestWithBody ¶
func NewUpsertPresetRequestWithBody(server string, presetId string, contentType string, body io.Reader) (*http.Request, error)
NewUpsertPresetRequestWithBody generates requests for UpsertPreset with any type of body
func NewUpsertSearchOverrideRequest ¶
func NewUpsertSearchOverrideRequest(server string, collectionName string, overrideId string, body UpsertSearchOverrideJSONRequestBody) (*http.Request, error)
NewUpsertSearchOverrideRequest calls the generic UpsertSearchOverride builder with application/json body
func NewUpsertSearchOverrideRequestWithBody ¶
func NewUpsertSearchOverrideRequestWithBody(server string, collectionName string, overrideId string, contentType string, body io.Reader) (*http.Request, error)
NewUpsertSearchOverrideRequestWithBody generates requests for UpsertSearchOverride with any type of body
func NewUpsertSearchSynonymRequest ¶
func NewUpsertSearchSynonymRequest(server string, collectionName string, synonymId string, body UpsertSearchSynonymJSONRequestBody) (*http.Request, error)
NewUpsertSearchSynonymRequest calls the generic UpsertSearchSynonym builder with application/json body
func NewUpsertSearchSynonymRequestWithBody ¶
func NewUpsertSearchSynonymRequestWithBody(server string, collectionName string, synonymId string, contentType string, body io.Reader) (*http.Request, error)
NewUpsertSearchSynonymRequestWithBody generates requests for UpsertSearchSynonym with any type of body
func NewUpsertStopwordsSetRequest ¶
func NewUpsertStopwordsSetRequest(server string, setId string, body UpsertStopwordsSetJSONRequestBody) (*http.Request, error)
NewUpsertStopwordsSetRequest calls the generic UpsertStopwordsSet builder with application/json body
Types ¶
type APIStatsResponse ¶
type APIStatsResponse struct {
DeleteLatencyMs *float64 `json:"delete_latency_ms,omitempty"`
DeleteRequestsPerSecond *float64 `json:"delete_requests_per_second,omitempty"`
ImportLatencyMs *float64 `json:"import_latency_ms,omitempty"`
ImportRequestsPerSecond *float64 `json:"import_requests_per_second,omitempty"`
LatencyMs *map[string]float64 `json:"latency_ms,omitempty"`
OverloadedRequestsPerSecond *float64 `json:"overloaded_requests_per_second,omitempty"`
PendingWriteBatches *float64 `json:"pending_write_batches,omitempty"`
RequestsPerSecond *map[string]float64 `json:"requests_per_second,omitempty"`
SearchLatencyMs *float64 `json:"search_latency_ms,omitempty"`
SearchRequestsPerSecond *float64 `json:"search_requests_per_second,omitempty"`
TotalRequestsPerSecond *float64 `json:"total_requests_per_second,omitempty"`
WriteLatencyMs *float64 `json:"write_latency_ms,omitempty"`
WriteRequestsPerSecond *float64 `json:"write_requests_per_second,omitempty"`
}
APIStatsResponse defines model for APIStatsResponse.
type AnalyticsEventCreateResponse ¶
type AnalyticsEventCreateResponse struct {
Ok bool `json:"ok"`
}
AnalyticsEventCreateResponse defines model for AnalyticsEventCreateResponse.
type AnalyticsEventCreateSchema ¶
type AnalyticsEventCreateSchema struct {
Data map[string]interface{} `json:"data"`
Name string `json:"name"`
Type string `json:"type"`
}
AnalyticsEventCreateSchema defines model for AnalyticsEventCreateSchema.
type AnalyticsRuleDeleteResponse ¶
type AnalyticsRuleDeleteResponse struct {
Name string `json:"name"`
}
AnalyticsRuleDeleteResponse defines model for AnalyticsRuleDeleteResponse.
type AnalyticsRuleParameters ¶
type AnalyticsRuleParameters struct {
Destination AnalyticsRuleParametersDestination `json:"destination"`
ExpandQuery *bool `json:"expand_query,omitempty"`
Limit *int `json:"limit,omitempty"`
Source AnalyticsRuleParametersSource `json:"source"`
}
AnalyticsRuleParameters defines model for AnalyticsRuleParameters.
type AnalyticsRuleParametersDestination ¶
type AnalyticsRuleParametersDestination struct {
Collection string `json:"collection"`
CounterField *string `json:"counter_field,omitempty"`
}
AnalyticsRuleParametersDestination defines model for AnalyticsRuleParametersDestination.
type AnalyticsRuleParametersSource ¶
type AnalyticsRuleParametersSource struct {
Collections []string `json:"collections"`
Events *[]struct {
Name string `json:"name"`
Type string `json:"type"`
Weight float32 `json:"weight"`
} `json:"events,omitempty"`
}
AnalyticsRuleParametersSource defines model for AnalyticsRuleParametersSource.
type AnalyticsRuleSchema ¶
type AnalyticsRuleSchema struct {
Name string `json:"name"`
Params AnalyticsRuleParameters `json:"params"`
Type AnalyticsRuleSchemaType `json:"type"`
}
AnalyticsRuleSchema defines model for AnalyticsRuleSchema.
type AnalyticsRuleSchemaType ¶
type AnalyticsRuleSchemaType string
AnalyticsRuleSchemaType defines model for AnalyticsRuleSchema.Type.
const ( AnalyticsRuleSchemaTypeCounter AnalyticsRuleSchemaType = "counter" AnalyticsRuleSchemaTypeNohitsQueries AnalyticsRuleSchemaType = "nohits_queries" AnalyticsRuleSchemaTypePopularQueries AnalyticsRuleSchemaType = "popular_queries" )
Defines values for AnalyticsRuleSchemaType.
type AnalyticsRuleUpsertSchema ¶
type AnalyticsRuleUpsertSchema struct {
Params AnalyticsRuleParameters `json:"params"`
Type AnalyticsRuleUpsertSchemaType `json:"type"`
}
AnalyticsRuleUpsertSchema defines model for AnalyticsRuleUpsertSchema.
type AnalyticsRuleUpsertSchemaType ¶
type AnalyticsRuleUpsertSchemaType string
AnalyticsRuleUpsertSchemaType defines model for AnalyticsRuleUpsertSchema.Type.
const ( AnalyticsRuleUpsertSchemaTypeCounter AnalyticsRuleUpsertSchemaType = "counter" AnalyticsRuleUpsertSchemaTypeNohitsQueries AnalyticsRuleUpsertSchemaType = "nohits_queries" AnalyticsRuleUpsertSchemaTypePopularQueries AnalyticsRuleUpsertSchemaType = "popular_queries" )
Defines values for AnalyticsRuleUpsertSchemaType.
type AnalyticsRulesRetrieveSchema ¶
type AnalyticsRulesRetrieveSchema struct {
Rules *[]*AnalyticsRuleSchema `json:"rules,omitempty"`
}
AnalyticsRulesRetrieveSchema defines model for AnalyticsRulesRetrieveSchema.
type ApiKey ¶
type ApiKey struct {
Actions []string `json:"actions"`
Collections []string `json:"collections"`
Description string `json:"description"`
ExpiresAt *int64 `json:"expires_at,omitempty"`
Id *int64 `json:"id,omitempty"`
Value *string `json:"value,omitempty"`
ValuePrefix *string `json:"value_prefix,omitempty"`
}
ApiKey defines model for ApiKey.
type ApiKeyDeleteResponse ¶
type ApiKeyDeleteResponse struct {
// Id The id of the API key that was deleted
Id int64 `json:"id"`
}
ApiKeyDeleteResponse defines model for ApiKeyDeleteResponse.
type ApiKeySchema ¶
type ApiKeySchema struct {
Actions []string `json:"actions"`
Collections []string `json:"collections"`
Description string `json:"description"`
ExpiresAt *int64 `json:"expires_at,omitempty"`
Value *string `json:"value,omitempty"`
}
ApiKeySchema defines model for ApiKeySchema.
type ApiKeysResponse ¶
type ApiKeysResponse struct {
Keys []*ApiKey `json:"keys"`
}
ApiKeysResponse defines model for ApiKeysResponse.
type ApiResponse ¶
type ApiResponse struct {
Message string `json:"message"`
}
ApiResponse defines model for ApiResponse.
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) CreateAnalyticsEvent ¶
func (c *Client) CreateAnalyticsEvent(ctx context.Context, body CreateAnalyticsEventJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateAnalyticsEventWithBody ¶
func (*Client) CreateAnalyticsRule ¶
func (c *Client) CreateAnalyticsRule(ctx context.Context, body CreateAnalyticsRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateAnalyticsRuleWithBody ¶
func (*Client) CreateCollection ¶
func (c *Client) CreateCollection(ctx context.Context, body CreateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateCollectionWithBody ¶
func (*Client) CreateConversationModel ¶
func (c *Client) CreateConversationModel(ctx context.Context, body CreateConversationModelJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateConversationModelWithBody ¶
func (*Client) CreateKey ¶
func (c *Client) CreateKey(ctx context.Context, body CreateKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateKeyWithBody ¶
func (*Client) DeleteAlias ¶
func (*Client) DeleteAnalyticsRule ¶
func (*Client) DeleteCollection ¶
func (*Client) DeleteConversationModel ¶
func (*Client) DeleteDocument ¶
func (*Client) DeleteDocuments ¶
func (c *Client) DeleteDocuments(ctx context.Context, collectionName string, params *DeleteDocumentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) DeletePreset ¶
func (*Client) DeleteSearchOverride ¶
func (*Client) DeleteSearchSynonym ¶
func (*Client) DeleteStopwordsSet ¶
func (*Client) ExportDocuments ¶
func (c *Client) ExportDocuments(ctx context.Context, collectionName string, params *ExportDocumentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetAliases ¶
func (*Client) GetCollection ¶
func (*Client) GetCollections ¶
func (*Client) GetDocument ¶
func (*Client) GetSchemaChanges ¶
func (*Client) GetSearchOverride ¶
func (*Client) GetSearchOverrides ¶
func (*Client) GetSearchSynonym ¶
func (*Client) GetSearchSynonyms ¶
func (*Client) GetStemmingDictionary ¶
func (*Client) ImportDocumentsWithBody ¶
func (*Client) ImportStemmingDictionary ¶
func (c *Client) ImportStemmingDictionary(ctx context.Context, params *ImportStemmingDictionaryParams, body ImportStemmingDictionaryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ImportStemmingDictionaryWithBody ¶
func (*Client) IndexDocument ¶
func (c *Client) IndexDocument(ctx context.Context, collectionName string, params *IndexDocumentParams, body IndexDocumentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) IndexDocumentWithBody ¶
func (*Client) ListStemmingDictionaries ¶
func (*Client) MultiSearch ¶
func (c *Client) MultiSearch(ctx context.Context, params *MultiSearchParams, body MultiSearchJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) MultiSearchWithBody ¶
func (*Client) RetrieveAPIStats ¶
func (*Client) RetrieveAllConversationModels ¶
func (*Client) RetrieveAllPresets ¶
func (*Client) RetrieveAnalyticsRule ¶
func (*Client) RetrieveAnalyticsRules ¶
func (*Client) RetrieveConversationModel ¶
func (*Client) RetrieveMetrics ¶
func (*Client) RetrievePreset ¶
func (*Client) RetrieveStopwordsSet ¶
func (*Client) RetrieveStopwordsSets ¶
func (*Client) SearchCollection ¶
func (c *Client) SearchCollection(ctx context.Context, collectionName string, params *SearchCollectionParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) TakeSnapshot ¶
func (c *Client) TakeSnapshot(ctx context.Context, params *TakeSnapshotParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateCollection ¶
func (c *Client) UpdateCollection(ctx context.Context, collectionName string, body UpdateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateCollectionWithBody ¶
func (*Client) UpdateConversationModel ¶
func (c *Client) UpdateConversationModel(ctx context.Context, modelId string, body UpdateConversationModelJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateConversationModelWithBody ¶
func (*Client) UpdateDocument ¶
func (c *Client) UpdateDocument(ctx context.Context, collectionName string, documentId string, params *UpdateDocumentParams, body UpdateDocumentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateDocumentWithBody ¶
func (*Client) UpdateDocuments ¶
func (c *Client) UpdateDocuments(ctx context.Context, collectionName string, params *UpdateDocumentsParams, body UpdateDocumentsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateDocumentsWithBody ¶
func (*Client) UpsertAlias ¶
func (c *Client) UpsertAlias(ctx context.Context, aliasName string, body UpsertAliasJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpsertAliasWithBody ¶
func (*Client) UpsertAnalyticsRule ¶
func (c *Client) UpsertAnalyticsRule(ctx context.Context, ruleName string, body UpsertAnalyticsRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpsertAnalyticsRuleWithBody ¶
func (*Client) UpsertPreset ¶
func (c *Client) UpsertPreset(ctx context.Context, presetId string, body UpsertPresetJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpsertPresetWithBody ¶
func (*Client) UpsertSearchOverride ¶
func (c *Client) UpsertSearchOverride(ctx context.Context, collectionName string, overrideId string, body UpsertSearchOverrideJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpsertSearchOverrideWithBody ¶
func (*Client) UpsertSearchSynonym ¶
func (c *Client) UpsertSearchSynonym(ctx context.Context, collectionName string, synonymId string, body UpsertSearchSynonymJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpsertSearchSynonymWithBody ¶
func (*Client) UpsertStopwordsSet ¶
func (c *Client) UpsertStopwordsSet(ctx context.Context, setId string, body UpsertStopwordsSetJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpsertStopwordsSetWithBody ¶
type ClientInterface ¶
type ClientInterface interface {
// GetAliases request
GetAliases(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteAlias request
DeleteAlias(ctx context.Context, aliasName string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetAlias request
GetAlias(ctx context.Context, aliasName string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpsertAliasWithBody request with any body
UpsertAliasWithBody(ctx context.Context, aliasName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpsertAlias(ctx context.Context, aliasName string, body UpsertAliasJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateAnalyticsEventWithBody request with any body
CreateAnalyticsEventWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateAnalyticsEvent(ctx context.Context, body CreateAnalyticsEventJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// RetrieveAnalyticsRules request
RetrieveAnalyticsRules(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateAnalyticsRuleWithBody request with any body
CreateAnalyticsRuleWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateAnalyticsRule(ctx context.Context, body CreateAnalyticsRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteAnalyticsRule request
DeleteAnalyticsRule(ctx context.Context, ruleName string, reqEditors ...RequestEditorFn) (*http.Response, error)
// RetrieveAnalyticsRule request
RetrieveAnalyticsRule(ctx context.Context, ruleName string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpsertAnalyticsRuleWithBody request with any body
UpsertAnalyticsRuleWithBody(ctx context.Context, ruleName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpsertAnalyticsRule(ctx context.Context, ruleName string, body UpsertAnalyticsRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetCollections request
GetCollections(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateCollectionWithBody request with any body
CreateCollectionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateCollection(ctx context.Context, body CreateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteCollection request
DeleteCollection(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetCollection request
GetCollection(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateCollectionWithBody request with any body
UpdateCollectionWithBody(ctx context.Context, collectionName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateCollection(ctx context.Context, collectionName string, body UpdateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteDocuments request
DeleteDocuments(ctx context.Context, collectionName string, params *DeleteDocumentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateDocumentsWithBody request with any body
UpdateDocumentsWithBody(ctx context.Context, collectionName string, params *UpdateDocumentsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateDocuments(ctx context.Context, collectionName string, params *UpdateDocumentsParams, body UpdateDocumentsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// IndexDocumentWithBody request with any body
IndexDocumentWithBody(ctx context.Context, collectionName string, params *IndexDocumentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
IndexDocument(ctx context.Context, collectionName string, params *IndexDocumentParams, body IndexDocumentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ExportDocuments request
ExportDocuments(ctx context.Context, collectionName string, params *ExportDocumentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// ImportDocumentsWithBody request with any body
ImportDocumentsWithBody(ctx context.Context, collectionName string, params *ImportDocumentsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// SearchCollection request
SearchCollection(ctx context.Context, collectionName string, params *SearchCollectionParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteDocument request
DeleteDocument(ctx context.Context, collectionName string, documentId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetDocument request
GetDocument(ctx context.Context, collectionName string, documentId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateDocumentWithBody request with any body
UpdateDocumentWithBody(ctx context.Context, collectionName string, documentId string, params *UpdateDocumentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateDocument(ctx context.Context, collectionName string, documentId string, params *UpdateDocumentParams, body UpdateDocumentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSearchOverrides request
GetSearchOverrides(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteSearchOverride request
DeleteSearchOverride(ctx context.Context, collectionName string, overrideId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSearchOverride request
GetSearchOverride(ctx context.Context, collectionName string, overrideId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpsertSearchOverrideWithBody request with any body
UpsertSearchOverrideWithBody(ctx context.Context, collectionName string, overrideId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpsertSearchOverride(ctx context.Context, collectionName string, overrideId string, body UpsertSearchOverrideJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSearchSynonyms request
GetSearchSynonyms(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteSearchSynonym request
DeleteSearchSynonym(ctx context.Context, collectionName string, synonymId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSearchSynonym request
GetSearchSynonym(ctx context.Context, collectionName string, synonymId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpsertSearchSynonymWithBody request with any body
UpsertSearchSynonymWithBody(ctx context.Context, collectionName string, synonymId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpsertSearchSynonym(ctx context.Context, collectionName string, synonymId string, body UpsertSearchSynonymJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// RetrieveAllConversationModels request
RetrieveAllConversationModels(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateConversationModelWithBody request with any body
CreateConversationModelWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateConversationModel(ctx context.Context, body CreateConversationModelJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteConversationModel request
DeleteConversationModel(ctx context.Context, modelId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// RetrieveConversationModel request
RetrieveConversationModel(ctx context.Context, modelId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateConversationModelWithBody request with any body
UpdateConversationModelWithBody(ctx context.Context, modelId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateConversationModel(ctx context.Context, modelId string, body UpdateConversationModelJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// Debug request
Debug(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// Health request
Health(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetKeys request
GetKeys(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateKeyWithBody request with any body
CreateKeyWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateKey(ctx context.Context, body CreateKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteKey request
DeleteKey(ctx context.Context, keyId int64, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetKey request
GetKey(ctx context.Context, keyId int64, reqEditors ...RequestEditorFn) (*http.Response, error)
// RetrieveMetrics request
RetrieveMetrics(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// MultiSearchWithBody request with any body
MultiSearchWithBody(ctx context.Context, params *MultiSearchParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
MultiSearch(ctx context.Context, params *MultiSearchParams, body MultiSearchJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSchemaChanges request
GetSchemaChanges(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// TakeSnapshot request
TakeSnapshot(ctx context.Context, params *TakeSnapshotParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// Vote request
Vote(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// RetrieveAllPresets request
RetrieveAllPresets(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeletePreset request
DeletePreset(ctx context.Context, presetId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// RetrievePreset request
RetrievePreset(ctx context.Context, presetId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpsertPresetWithBody request with any body
UpsertPresetWithBody(ctx context.Context, presetId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpsertPreset(ctx context.Context, presetId string, body UpsertPresetJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// RetrieveAPIStats request
RetrieveAPIStats(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListStemmingDictionaries request
ListStemmingDictionaries(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// ImportStemmingDictionaryWithBody request with any body
ImportStemmingDictionaryWithBody(ctx context.Context, params *ImportStemmingDictionaryParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
ImportStemmingDictionary(ctx context.Context, params *ImportStemmingDictionaryParams, body ImportStemmingDictionaryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetStemmingDictionary request
GetStemmingDictionary(ctx context.Context, dictionaryId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// RetrieveStopwordsSets request
RetrieveStopwordsSets(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteStopwordsSet request
DeleteStopwordsSet(ctx context.Context, setId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// RetrieveStopwordsSet request
RetrieveStopwordsSet(ctx context.Context, setId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpsertStopwordsSetWithBody request with any body
UpsertStopwordsSetWithBody(ctx context.Context, setId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpsertStopwordsSet(ctx context.Context, setId string, body UpsertStopwordsSetJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithAPIKey ¶
func WithAPIKey(apiKey string) ClientOption
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) CreateAnalyticsEventWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateAnalyticsEventWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAnalyticsEventResponse, error)
CreateAnalyticsEventWithBodyWithResponse request with arbitrary body returning *CreateAnalyticsEventResponse
func (*ClientWithResponses) CreateAnalyticsEventWithResponse ¶
func (c *ClientWithResponses) CreateAnalyticsEventWithResponse(ctx context.Context, body CreateAnalyticsEventJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAnalyticsEventResponse, error)
func (*ClientWithResponses) CreateAnalyticsRuleWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateAnalyticsRuleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAnalyticsRuleResponse, error)
CreateAnalyticsRuleWithBodyWithResponse request with arbitrary body returning *CreateAnalyticsRuleResponse
func (*ClientWithResponses) CreateAnalyticsRuleWithResponse ¶
func (c *ClientWithResponses) CreateAnalyticsRuleWithResponse(ctx context.Context, body CreateAnalyticsRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAnalyticsRuleResponse, error)
func (*ClientWithResponses) CreateCollectionWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateCollectionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateCollectionResponse, error)
CreateCollectionWithBodyWithResponse request with arbitrary body returning *CreateCollectionResponse
func (*ClientWithResponses) CreateCollectionWithResponse ¶
func (c *ClientWithResponses) CreateCollectionWithResponse(ctx context.Context, body CreateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateCollectionResponse, error)
func (*ClientWithResponses) CreateConversationModelWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateConversationModelWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateConversationModelResponse, error)
CreateConversationModelWithBodyWithResponse request with arbitrary body returning *CreateConversationModelResponse
func (*ClientWithResponses) CreateConversationModelWithResponse ¶
func (c *ClientWithResponses) CreateConversationModelWithResponse(ctx context.Context, body CreateConversationModelJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateConversationModelResponse, error)
func (*ClientWithResponses) CreateKeyWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateKeyResponse, error)
CreateKeyWithBodyWithResponse request with arbitrary body returning *CreateKeyResponse
func (*ClientWithResponses) CreateKeyWithResponse ¶
func (c *ClientWithResponses) CreateKeyWithResponse(ctx context.Context, body CreateKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateKeyResponse, error)
func (*ClientWithResponses) DebugWithResponse ¶
func (c *ClientWithResponses) DebugWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*DebugResponse, error)
DebugWithResponse request returning *DebugResponse
func (*ClientWithResponses) DeleteAliasWithResponse ¶
func (c *ClientWithResponses) DeleteAliasWithResponse(ctx context.Context, aliasName string, reqEditors ...RequestEditorFn) (*DeleteAliasResponse, error)
DeleteAliasWithResponse request returning *DeleteAliasResponse
func (*ClientWithResponses) DeleteAnalyticsRuleWithResponse ¶
func (c *ClientWithResponses) DeleteAnalyticsRuleWithResponse(ctx context.Context, ruleName string, reqEditors ...RequestEditorFn) (*DeleteAnalyticsRuleResponse, error)
DeleteAnalyticsRuleWithResponse request returning *DeleteAnalyticsRuleResponse
func (*ClientWithResponses) DeleteCollectionWithResponse ¶
func (c *ClientWithResponses) DeleteCollectionWithResponse(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*DeleteCollectionResponse, error)
DeleteCollectionWithResponse request returning *DeleteCollectionResponse
func (*ClientWithResponses) DeleteConversationModelWithResponse ¶
func (c *ClientWithResponses) DeleteConversationModelWithResponse(ctx context.Context, modelId string, reqEditors ...RequestEditorFn) (*DeleteConversationModelResponse, error)
DeleteConversationModelWithResponse request returning *DeleteConversationModelResponse
func (*ClientWithResponses) DeleteDocumentWithResponse ¶
func (c *ClientWithResponses) DeleteDocumentWithResponse(ctx context.Context, collectionName string, documentId string, reqEditors ...RequestEditorFn) (*DeleteDocumentResponse, error)
DeleteDocumentWithResponse request returning *DeleteDocumentResponse
func (*ClientWithResponses) DeleteDocumentsWithResponse ¶
func (c *ClientWithResponses) DeleteDocumentsWithResponse(ctx context.Context, collectionName string, params *DeleteDocumentsParams, reqEditors ...RequestEditorFn) (*DeleteDocumentsResponse, error)
DeleteDocumentsWithResponse request returning *DeleteDocumentsResponse
func (*ClientWithResponses) DeleteKeyWithResponse ¶
func (c *ClientWithResponses) DeleteKeyWithResponse(ctx context.Context, keyId int64, reqEditors ...RequestEditorFn) (*DeleteKeyResponse, error)
DeleteKeyWithResponse request returning *DeleteKeyResponse
func (*ClientWithResponses) DeletePresetWithResponse ¶
func (c *ClientWithResponses) DeletePresetWithResponse(ctx context.Context, presetId string, reqEditors ...RequestEditorFn) (*DeletePresetResponse, error)
DeletePresetWithResponse request returning *DeletePresetResponse
func (*ClientWithResponses) DeleteSearchOverrideWithResponse ¶
func (c *ClientWithResponses) DeleteSearchOverrideWithResponse(ctx context.Context, collectionName string, overrideId string, reqEditors ...RequestEditorFn) (*DeleteSearchOverrideResponse, error)
DeleteSearchOverrideWithResponse request returning *DeleteSearchOverrideResponse
func (*ClientWithResponses) DeleteSearchSynonymWithResponse ¶
func (c *ClientWithResponses) DeleteSearchSynonymWithResponse(ctx context.Context, collectionName string, synonymId string, reqEditors ...RequestEditorFn) (*DeleteSearchSynonymResponse, error)
DeleteSearchSynonymWithResponse request returning *DeleteSearchSynonymResponse
func (*ClientWithResponses) DeleteStopwordsSetWithResponse ¶
func (c *ClientWithResponses) DeleteStopwordsSetWithResponse(ctx context.Context, setId string, reqEditors ...RequestEditorFn) (*DeleteStopwordsSetResponse, error)
DeleteStopwordsSetWithResponse request returning *DeleteStopwordsSetResponse
func (*ClientWithResponses) ExportDocumentsWithResponse ¶
func (c *ClientWithResponses) ExportDocumentsWithResponse(ctx context.Context, collectionName string, params *ExportDocumentsParams, reqEditors ...RequestEditorFn) (*ExportDocumentsResponse, error)
ExportDocumentsWithResponse request returning *ExportDocumentsResponse
func (*ClientWithResponses) GetAliasWithResponse ¶
func (c *ClientWithResponses) GetAliasWithResponse(ctx context.Context, aliasName string, reqEditors ...RequestEditorFn) (*GetAliasResponse, error)
GetAliasWithResponse request returning *GetAliasResponse
func (*ClientWithResponses) GetAliasesWithResponse ¶
func (c *ClientWithResponses) GetAliasesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAliasesResponse, error)
GetAliasesWithResponse request returning *GetAliasesResponse
func (*ClientWithResponses) GetCollectionWithResponse ¶
func (c *ClientWithResponses) GetCollectionWithResponse(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*GetCollectionResponse, error)
GetCollectionWithResponse request returning *GetCollectionResponse
func (*ClientWithResponses) GetCollectionsWithResponse ¶
func (c *ClientWithResponses) GetCollectionsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCollectionsResponse, error)
GetCollectionsWithResponse request returning *GetCollectionsResponse
func (*ClientWithResponses) GetDocumentWithResponse ¶
func (c *ClientWithResponses) GetDocumentWithResponse(ctx context.Context, collectionName string, documentId string, reqEditors ...RequestEditorFn) (*GetDocumentResponse, error)
GetDocumentWithResponse request returning *GetDocumentResponse
func (*ClientWithResponses) GetKeyWithResponse ¶
func (c *ClientWithResponses) GetKeyWithResponse(ctx context.Context, keyId int64, reqEditors ...RequestEditorFn) (*GetKeyResponse, error)
GetKeyWithResponse request returning *GetKeyResponse
func (*ClientWithResponses) GetKeysWithResponse ¶
func (c *ClientWithResponses) GetKeysWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetKeysResponse, error)
GetKeysWithResponse request returning *GetKeysResponse
func (*ClientWithResponses) GetSchemaChangesWithResponse ¶
func (c *ClientWithResponses) GetSchemaChangesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSchemaChangesResponse, error)
GetSchemaChangesWithResponse request returning *GetSchemaChangesResponse
func (*ClientWithResponses) GetSearchOverrideWithResponse ¶
func (c *ClientWithResponses) GetSearchOverrideWithResponse(ctx context.Context, collectionName string, overrideId string, reqEditors ...RequestEditorFn) (*GetSearchOverrideResponse, error)
GetSearchOverrideWithResponse request returning *GetSearchOverrideResponse
func (*ClientWithResponses) GetSearchOverridesWithResponse ¶
func (c *ClientWithResponses) GetSearchOverridesWithResponse(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*GetSearchOverridesResponse, error)
GetSearchOverridesWithResponse request returning *GetSearchOverridesResponse
func (*ClientWithResponses) GetSearchSynonymWithResponse ¶
func (c *ClientWithResponses) GetSearchSynonymWithResponse(ctx context.Context, collectionName string, synonymId string, reqEditors ...RequestEditorFn) (*GetSearchSynonymResponse, error)
GetSearchSynonymWithResponse request returning *GetSearchSynonymResponse
func (*ClientWithResponses) GetSearchSynonymsWithResponse ¶
func (c *ClientWithResponses) GetSearchSynonymsWithResponse(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*GetSearchSynonymsResponse, error)
GetSearchSynonymsWithResponse request returning *GetSearchSynonymsResponse
func (*ClientWithResponses) GetStemmingDictionaryWithResponse ¶
func (c *ClientWithResponses) GetStemmingDictionaryWithResponse(ctx context.Context, dictionaryId string, reqEditors ...RequestEditorFn) (*GetStemmingDictionaryResponse, error)
GetStemmingDictionaryWithResponse request returning *GetStemmingDictionaryResponse
func (*ClientWithResponses) HealthWithResponse ¶
func (c *ClientWithResponses) HealthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthResponse, error)
HealthWithResponse request returning *HealthResponse
func (*ClientWithResponses) ImportDocumentsWithBodyWithResponse ¶
func (c *ClientWithResponses) ImportDocumentsWithBodyWithResponse(ctx context.Context, collectionName string, params *ImportDocumentsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ImportDocumentsResponse, error)
ImportDocumentsWithBodyWithResponse request with arbitrary body returning *ImportDocumentsResponse
func (*ClientWithResponses) ImportStemmingDictionaryWithBodyWithResponse ¶
func (c *ClientWithResponses) ImportStemmingDictionaryWithBodyWithResponse(ctx context.Context, params *ImportStemmingDictionaryParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ImportStemmingDictionaryResponse, error)
ImportStemmingDictionaryWithBodyWithResponse request with arbitrary body returning *ImportStemmingDictionaryResponse
func (*ClientWithResponses) ImportStemmingDictionaryWithResponse ¶
func (c *ClientWithResponses) ImportStemmingDictionaryWithResponse(ctx context.Context, params *ImportStemmingDictionaryParams, body ImportStemmingDictionaryJSONRequestBody, reqEditors ...RequestEditorFn) (*ImportStemmingDictionaryResponse, error)
func (*ClientWithResponses) IndexDocumentWithBodyWithResponse ¶
func (c *ClientWithResponses) IndexDocumentWithBodyWithResponse(ctx context.Context, collectionName string, params *IndexDocumentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*IndexDocumentResponse, error)
IndexDocumentWithBodyWithResponse request with arbitrary body returning *IndexDocumentResponse
func (*ClientWithResponses) IndexDocumentWithResponse ¶
func (c *ClientWithResponses) IndexDocumentWithResponse(ctx context.Context, collectionName string, params *IndexDocumentParams, body IndexDocumentJSONRequestBody, reqEditors ...RequestEditorFn) (*IndexDocumentResponse, error)
func (*ClientWithResponses) ListStemmingDictionariesWithResponse ¶
func (c *ClientWithResponses) ListStemmingDictionariesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListStemmingDictionariesResponse, error)
ListStemmingDictionariesWithResponse request returning *ListStemmingDictionariesResponse
func (*ClientWithResponses) MultiSearchWithBodyWithResponse ¶
func (c *ClientWithResponses) MultiSearchWithBodyWithResponse(ctx context.Context, params *MultiSearchParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MultiSearchResponse, error)
MultiSearchWithBodyWithResponse request with arbitrary body returning *MultiSearchResponse
func (*ClientWithResponses) MultiSearchWithResponse ¶
func (c *ClientWithResponses) MultiSearchWithResponse(ctx context.Context, params *MultiSearchParams, body MultiSearchJSONRequestBody, reqEditors ...RequestEditorFn) (*MultiSearchResponse, error)
func (*ClientWithResponses) RetrieveAPIStatsWithResponse ¶
func (c *ClientWithResponses) RetrieveAPIStatsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveAPIStatsResponse, error)
RetrieveAPIStatsWithResponse request returning *RetrieveAPIStatsResponse
func (*ClientWithResponses) RetrieveAllConversationModelsWithResponse ¶
func (c *ClientWithResponses) RetrieveAllConversationModelsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveAllConversationModelsResponse, error)
RetrieveAllConversationModelsWithResponse request returning *RetrieveAllConversationModelsResponse
func (*ClientWithResponses) RetrieveAllPresetsWithResponse ¶
func (c *ClientWithResponses) RetrieveAllPresetsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveAllPresetsResponse, error)
RetrieveAllPresetsWithResponse request returning *RetrieveAllPresetsResponse
func (*ClientWithResponses) RetrieveAnalyticsRuleWithResponse ¶
func (c *ClientWithResponses) RetrieveAnalyticsRuleWithResponse(ctx context.Context, ruleName string, reqEditors ...RequestEditorFn) (*RetrieveAnalyticsRuleResponse, error)
RetrieveAnalyticsRuleWithResponse request returning *RetrieveAnalyticsRuleResponse
func (*ClientWithResponses) RetrieveAnalyticsRulesWithResponse ¶
func (c *ClientWithResponses) RetrieveAnalyticsRulesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveAnalyticsRulesResponse, error)
RetrieveAnalyticsRulesWithResponse request returning *RetrieveAnalyticsRulesResponse
func (*ClientWithResponses) RetrieveConversationModelWithResponse ¶
func (c *ClientWithResponses) RetrieveConversationModelWithResponse(ctx context.Context, modelId string, reqEditors ...RequestEditorFn) (*RetrieveConversationModelResponse, error)
RetrieveConversationModelWithResponse request returning *RetrieveConversationModelResponse
func (*ClientWithResponses) RetrieveMetricsWithResponse ¶
func (c *ClientWithResponses) RetrieveMetricsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveMetricsResponse, error)
RetrieveMetricsWithResponse request returning *RetrieveMetricsResponse
func (*ClientWithResponses) RetrievePresetWithResponse ¶
func (c *ClientWithResponses) RetrievePresetWithResponse(ctx context.Context, presetId string, reqEditors ...RequestEditorFn) (*RetrievePresetResponse, error)
RetrievePresetWithResponse request returning *RetrievePresetResponse
func (*ClientWithResponses) RetrieveStopwordsSetWithResponse ¶
func (c *ClientWithResponses) RetrieveStopwordsSetWithResponse(ctx context.Context, setId string, reqEditors ...RequestEditorFn) (*RetrieveStopwordsSetResponse, error)
RetrieveStopwordsSetWithResponse request returning *RetrieveStopwordsSetResponse
func (*ClientWithResponses) RetrieveStopwordsSetsWithResponse ¶
func (c *ClientWithResponses) RetrieveStopwordsSetsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveStopwordsSetsResponse, error)
RetrieveStopwordsSetsWithResponse request returning *RetrieveStopwordsSetsResponse
func (*ClientWithResponses) SearchCollectionWithResponse ¶
func (c *ClientWithResponses) SearchCollectionWithResponse(ctx context.Context, collectionName string, params *SearchCollectionParams, reqEditors ...RequestEditorFn) (*SearchCollectionResponse, error)
SearchCollectionWithResponse request returning *SearchCollectionResponse
func (*ClientWithResponses) TakeSnapshotWithResponse ¶
func (c *ClientWithResponses) TakeSnapshotWithResponse(ctx context.Context, params *TakeSnapshotParams, reqEditors ...RequestEditorFn) (*TakeSnapshotResponse, error)
TakeSnapshotWithResponse request returning *TakeSnapshotResponse
func (*ClientWithResponses) UpdateCollectionWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateCollectionWithBodyWithResponse(ctx context.Context, collectionName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateCollectionResponse, error)
UpdateCollectionWithBodyWithResponse request with arbitrary body returning *UpdateCollectionResponse
func (*ClientWithResponses) UpdateCollectionWithResponse ¶
func (c *ClientWithResponses) UpdateCollectionWithResponse(ctx context.Context, collectionName string, body UpdateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateCollectionResponse, error)
func (*ClientWithResponses) UpdateConversationModelWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateConversationModelWithBodyWithResponse(ctx context.Context, modelId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateConversationModelResponse, error)
UpdateConversationModelWithBodyWithResponse request with arbitrary body returning *UpdateConversationModelResponse
func (*ClientWithResponses) UpdateConversationModelWithResponse ¶
func (c *ClientWithResponses) UpdateConversationModelWithResponse(ctx context.Context, modelId string, body UpdateConversationModelJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateConversationModelResponse, error)
func (*ClientWithResponses) UpdateDocumentWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateDocumentWithBodyWithResponse(ctx context.Context, collectionName string, documentId string, params *UpdateDocumentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDocumentResponse, error)
UpdateDocumentWithBodyWithResponse request with arbitrary body returning *UpdateDocumentResponse
func (*ClientWithResponses) UpdateDocumentWithResponse ¶
func (c *ClientWithResponses) UpdateDocumentWithResponse(ctx context.Context, collectionName string, documentId string, params *UpdateDocumentParams, body UpdateDocumentJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDocumentResponse, error)
func (*ClientWithResponses) UpdateDocumentsWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateDocumentsWithBodyWithResponse(ctx context.Context, collectionName string, params *UpdateDocumentsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDocumentsResponse, error)
UpdateDocumentsWithBodyWithResponse request with arbitrary body returning *UpdateDocumentsResponse
func (*ClientWithResponses) UpdateDocumentsWithResponse ¶
func (c *ClientWithResponses) UpdateDocumentsWithResponse(ctx context.Context, collectionName string, params *UpdateDocumentsParams, body UpdateDocumentsJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDocumentsResponse, error)
func (*ClientWithResponses) UpsertAliasWithBodyWithResponse ¶
func (c *ClientWithResponses) UpsertAliasWithBodyWithResponse(ctx context.Context, aliasName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpsertAliasResponse, error)
UpsertAliasWithBodyWithResponse request with arbitrary body returning *UpsertAliasResponse
func (*ClientWithResponses) UpsertAliasWithResponse ¶
func (c *ClientWithResponses) UpsertAliasWithResponse(ctx context.Context, aliasName string, body UpsertAliasJSONRequestBody, reqEditors ...RequestEditorFn) (*UpsertAliasResponse, error)
func (*ClientWithResponses) UpsertAnalyticsRuleWithBodyWithResponse ¶
func (c *ClientWithResponses) UpsertAnalyticsRuleWithBodyWithResponse(ctx context.Context, ruleName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpsertAnalyticsRuleResponse, error)
UpsertAnalyticsRuleWithBodyWithResponse request with arbitrary body returning *UpsertAnalyticsRuleResponse
func (*ClientWithResponses) UpsertAnalyticsRuleWithResponse ¶
func (c *ClientWithResponses) UpsertAnalyticsRuleWithResponse(ctx context.Context, ruleName string, body UpsertAnalyticsRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpsertAnalyticsRuleResponse, error)
func (*ClientWithResponses) UpsertPresetWithBodyWithResponse ¶
func (c *ClientWithResponses) UpsertPresetWithBodyWithResponse(ctx context.Context, presetId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpsertPresetResponse, error)
UpsertPresetWithBodyWithResponse request with arbitrary body returning *UpsertPresetResponse
func (*ClientWithResponses) UpsertPresetWithResponse ¶
func (c *ClientWithResponses) UpsertPresetWithResponse(ctx context.Context, presetId string, body UpsertPresetJSONRequestBody, reqEditors ...RequestEditorFn) (*UpsertPresetResponse, error)
func (*ClientWithResponses) UpsertSearchOverrideWithBodyWithResponse ¶
func (c *ClientWithResponses) UpsertSearchOverrideWithBodyWithResponse(ctx context.Context, collectionName string, overrideId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpsertSearchOverrideResponse, error)
UpsertSearchOverrideWithBodyWithResponse request with arbitrary body returning *UpsertSearchOverrideResponse
func (*ClientWithResponses) UpsertSearchOverrideWithResponse ¶
func (c *ClientWithResponses) UpsertSearchOverrideWithResponse(ctx context.Context, collectionName string, overrideId string, body UpsertSearchOverrideJSONRequestBody, reqEditors ...RequestEditorFn) (*UpsertSearchOverrideResponse, error)
func (*ClientWithResponses) UpsertSearchSynonymWithBodyWithResponse ¶
func (c *ClientWithResponses) UpsertSearchSynonymWithBodyWithResponse(ctx context.Context, collectionName string, synonymId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpsertSearchSynonymResponse, error)
UpsertSearchSynonymWithBodyWithResponse request with arbitrary body returning *UpsertSearchSynonymResponse
func (*ClientWithResponses) UpsertSearchSynonymWithResponse ¶
func (c *ClientWithResponses) UpsertSearchSynonymWithResponse(ctx context.Context, collectionName string, synonymId string, body UpsertSearchSynonymJSONRequestBody, reqEditors ...RequestEditorFn) (*UpsertSearchSynonymResponse, error)
func (*ClientWithResponses) UpsertStopwordsSetWithBodyWithResponse ¶
func (c *ClientWithResponses) UpsertStopwordsSetWithBodyWithResponse(ctx context.Context, setId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpsertStopwordsSetResponse, error)
UpsertStopwordsSetWithBodyWithResponse request with arbitrary body returning *UpsertStopwordsSetResponse
func (*ClientWithResponses) UpsertStopwordsSetWithResponse ¶
func (c *ClientWithResponses) UpsertStopwordsSetWithResponse(ctx context.Context, setId string, body UpsertStopwordsSetJSONRequestBody, reqEditors ...RequestEditorFn) (*UpsertStopwordsSetResponse, error)
func (*ClientWithResponses) VoteWithResponse ¶
func (c *ClientWithResponses) VoteWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*VoteResponse, error)
VoteWithResponse request returning *VoteResponse
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// GetAliasesWithResponse request
GetAliasesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAliasesResponse, error)
// DeleteAliasWithResponse request
DeleteAliasWithResponse(ctx context.Context, aliasName string, reqEditors ...RequestEditorFn) (*DeleteAliasResponse, error)
// GetAliasWithResponse request
GetAliasWithResponse(ctx context.Context, aliasName string, reqEditors ...RequestEditorFn) (*GetAliasResponse, error)
// UpsertAliasWithBodyWithResponse request with any body
UpsertAliasWithBodyWithResponse(ctx context.Context, aliasName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpsertAliasResponse, error)
UpsertAliasWithResponse(ctx context.Context, aliasName string, body UpsertAliasJSONRequestBody, reqEditors ...RequestEditorFn) (*UpsertAliasResponse, error)
// CreateAnalyticsEventWithBodyWithResponse request with any body
CreateAnalyticsEventWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAnalyticsEventResponse, error)
CreateAnalyticsEventWithResponse(ctx context.Context, body CreateAnalyticsEventJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAnalyticsEventResponse, error)
// RetrieveAnalyticsRulesWithResponse request
RetrieveAnalyticsRulesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveAnalyticsRulesResponse, error)
// CreateAnalyticsRuleWithBodyWithResponse request with any body
CreateAnalyticsRuleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAnalyticsRuleResponse, error)
CreateAnalyticsRuleWithResponse(ctx context.Context, body CreateAnalyticsRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAnalyticsRuleResponse, error)
// DeleteAnalyticsRuleWithResponse request
DeleteAnalyticsRuleWithResponse(ctx context.Context, ruleName string, reqEditors ...RequestEditorFn) (*DeleteAnalyticsRuleResponse, error)
// RetrieveAnalyticsRuleWithResponse request
RetrieveAnalyticsRuleWithResponse(ctx context.Context, ruleName string, reqEditors ...RequestEditorFn) (*RetrieveAnalyticsRuleResponse, error)
// UpsertAnalyticsRuleWithBodyWithResponse request with any body
UpsertAnalyticsRuleWithBodyWithResponse(ctx context.Context, ruleName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpsertAnalyticsRuleResponse, error)
UpsertAnalyticsRuleWithResponse(ctx context.Context, ruleName string, body UpsertAnalyticsRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpsertAnalyticsRuleResponse, error)
// GetCollectionsWithResponse request
GetCollectionsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCollectionsResponse, error)
// CreateCollectionWithBodyWithResponse request with any body
CreateCollectionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateCollectionResponse, error)
CreateCollectionWithResponse(ctx context.Context, body CreateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateCollectionResponse, error)
// DeleteCollectionWithResponse request
DeleteCollectionWithResponse(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*DeleteCollectionResponse, error)
// GetCollectionWithResponse request
GetCollectionWithResponse(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*GetCollectionResponse, error)
// UpdateCollectionWithBodyWithResponse request with any body
UpdateCollectionWithBodyWithResponse(ctx context.Context, collectionName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateCollectionResponse, error)
UpdateCollectionWithResponse(ctx context.Context, collectionName string, body UpdateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateCollectionResponse, error)
// DeleteDocumentsWithResponse request
DeleteDocumentsWithResponse(ctx context.Context, collectionName string, params *DeleteDocumentsParams, reqEditors ...RequestEditorFn) (*DeleteDocumentsResponse, error)
// UpdateDocumentsWithBodyWithResponse request with any body
UpdateDocumentsWithBodyWithResponse(ctx context.Context, collectionName string, params *UpdateDocumentsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDocumentsResponse, error)
UpdateDocumentsWithResponse(ctx context.Context, collectionName string, params *UpdateDocumentsParams, body UpdateDocumentsJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDocumentsResponse, error)
// IndexDocumentWithBodyWithResponse request with any body
IndexDocumentWithBodyWithResponse(ctx context.Context, collectionName string, params *IndexDocumentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*IndexDocumentResponse, error)
IndexDocumentWithResponse(ctx context.Context, collectionName string, params *IndexDocumentParams, body IndexDocumentJSONRequestBody, reqEditors ...RequestEditorFn) (*IndexDocumentResponse, error)
// ExportDocumentsWithResponse request
ExportDocumentsWithResponse(ctx context.Context, collectionName string, params *ExportDocumentsParams, reqEditors ...RequestEditorFn) (*ExportDocumentsResponse, error)
// ImportDocumentsWithBodyWithResponse request with any body
ImportDocumentsWithBodyWithResponse(ctx context.Context, collectionName string, params *ImportDocumentsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ImportDocumentsResponse, error)
// SearchCollectionWithResponse request
SearchCollectionWithResponse(ctx context.Context, collectionName string, params *SearchCollectionParams, reqEditors ...RequestEditorFn) (*SearchCollectionResponse, error)
// DeleteDocumentWithResponse request
DeleteDocumentWithResponse(ctx context.Context, collectionName string, documentId string, reqEditors ...RequestEditorFn) (*DeleteDocumentResponse, error)
// GetDocumentWithResponse request
GetDocumentWithResponse(ctx context.Context, collectionName string, documentId string, reqEditors ...RequestEditorFn) (*GetDocumentResponse, error)
// UpdateDocumentWithBodyWithResponse request with any body
UpdateDocumentWithBodyWithResponse(ctx context.Context, collectionName string, documentId string, params *UpdateDocumentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDocumentResponse, error)
UpdateDocumentWithResponse(ctx context.Context, collectionName string, documentId string, params *UpdateDocumentParams, body UpdateDocumentJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDocumentResponse, error)
// GetSearchOverridesWithResponse request
GetSearchOverridesWithResponse(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*GetSearchOverridesResponse, error)
// DeleteSearchOverrideWithResponse request
DeleteSearchOverrideWithResponse(ctx context.Context, collectionName string, overrideId string, reqEditors ...RequestEditorFn) (*DeleteSearchOverrideResponse, error)
// GetSearchOverrideWithResponse request
GetSearchOverrideWithResponse(ctx context.Context, collectionName string, overrideId string, reqEditors ...RequestEditorFn) (*GetSearchOverrideResponse, error)
// UpsertSearchOverrideWithBodyWithResponse request with any body
UpsertSearchOverrideWithBodyWithResponse(ctx context.Context, collectionName string, overrideId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpsertSearchOverrideResponse, error)
UpsertSearchOverrideWithResponse(ctx context.Context, collectionName string, overrideId string, body UpsertSearchOverrideJSONRequestBody, reqEditors ...RequestEditorFn) (*UpsertSearchOverrideResponse, error)
// GetSearchSynonymsWithResponse request
GetSearchSynonymsWithResponse(ctx context.Context, collectionName string, reqEditors ...RequestEditorFn) (*GetSearchSynonymsResponse, error)
// DeleteSearchSynonymWithResponse request
DeleteSearchSynonymWithResponse(ctx context.Context, collectionName string, synonymId string, reqEditors ...RequestEditorFn) (*DeleteSearchSynonymResponse, error)
// GetSearchSynonymWithResponse request
GetSearchSynonymWithResponse(ctx context.Context, collectionName string, synonymId string, reqEditors ...RequestEditorFn) (*GetSearchSynonymResponse, error)
// UpsertSearchSynonymWithBodyWithResponse request with any body
UpsertSearchSynonymWithBodyWithResponse(ctx context.Context, collectionName string, synonymId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpsertSearchSynonymResponse, error)
UpsertSearchSynonymWithResponse(ctx context.Context, collectionName string, synonymId string, body UpsertSearchSynonymJSONRequestBody, reqEditors ...RequestEditorFn) (*UpsertSearchSynonymResponse, error)
// RetrieveAllConversationModelsWithResponse request
RetrieveAllConversationModelsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveAllConversationModelsResponse, error)
// CreateConversationModelWithBodyWithResponse request with any body
CreateConversationModelWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateConversationModelResponse, error)
CreateConversationModelWithResponse(ctx context.Context, body CreateConversationModelJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateConversationModelResponse, error)
// DeleteConversationModelWithResponse request
DeleteConversationModelWithResponse(ctx context.Context, modelId string, reqEditors ...RequestEditorFn) (*DeleteConversationModelResponse, error)
// RetrieveConversationModelWithResponse request
RetrieveConversationModelWithResponse(ctx context.Context, modelId string, reqEditors ...RequestEditorFn) (*RetrieveConversationModelResponse, error)
// UpdateConversationModelWithBodyWithResponse request with any body
UpdateConversationModelWithBodyWithResponse(ctx context.Context, modelId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateConversationModelResponse, error)
UpdateConversationModelWithResponse(ctx context.Context, modelId string, body UpdateConversationModelJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateConversationModelResponse, error)
// DebugWithResponse request
DebugWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*DebugResponse, error)
// HealthWithResponse request
HealthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthResponse, error)
// GetKeysWithResponse request
GetKeysWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetKeysResponse, error)
// CreateKeyWithBodyWithResponse request with any body
CreateKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateKeyResponse, error)
CreateKeyWithResponse(ctx context.Context, body CreateKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateKeyResponse, error)
// DeleteKeyWithResponse request
DeleteKeyWithResponse(ctx context.Context, keyId int64, reqEditors ...RequestEditorFn) (*DeleteKeyResponse, error)
// GetKeyWithResponse request
GetKeyWithResponse(ctx context.Context, keyId int64, reqEditors ...RequestEditorFn) (*GetKeyResponse, error)
// RetrieveMetricsWithResponse request
RetrieveMetricsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveMetricsResponse, error)
// MultiSearchWithBodyWithResponse request with any body
MultiSearchWithBodyWithResponse(ctx context.Context, params *MultiSearchParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MultiSearchResponse, error)
MultiSearchWithResponse(ctx context.Context, params *MultiSearchParams, body MultiSearchJSONRequestBody, reqEditors ...RequestEditorFn) (*MultiSearchResponse, error)
// GetSchemaChangesWithResponse request
GetSchemaChangesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSchemaChangesResponse, error)
// TakeSnapshotWithResponse request
TakeSnapshotWithResponse(ctx context.Context, params *TakeSnapshotParams, reqEditors ...RequestEditorFn) (*TakeSnapshotResponse, error)
// VoteWithResponse request
VoteWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*VoteResponse, error)
// RetrieveAllPresetsWithResponse request
RetrieveAllPresetsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveAllPresetsResponse, error)
// DeletePresetWithResponse request
DeletePresetWithResponse(ctx context.Context, presetId string, reqEditors ...RequestEditorFn) (*DeletePresetResponse, error)
// RetrievePresetWithResponse request
RetrievePresetWithResponse(ctx context.Context, presetId string, reqEditors ...RequestEditorFn) (*RetrievePresetResponse, error)
// UpsertPresetWithBodyWithResponse request with any body
UpsertPresetWithBodyWithResponse(ctx context.Context, presetId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpsertPresetResponse, error)
UpsertPresetWithResponse(ctx context.Context, presetId string, body UpsertPresetJSONRequestBody, reqEditors ...RequestEditorFn) (*UpsertPresetResponse, error)
// RetrieveAPIStatsWithResponse request
RetrieveAPIStatsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveAPIStatsResponse, error)
// ListStemmingDictionariesWithResponse request
ListStemmingDictionariesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListStemmingDictionariesResponse, error)
// ImportStemmingDictionaryWithBodyWithResponse request with any body
ImportStemmingDictionaryWithBodyWithResponse(ctx context.Context, params *ImportStemmingDictionaryParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ImportStemmingDictionaryResponse, error)
ImportStemmingDictionaryWithResponse(ctx context.Context, params *ImportStemmingDictionaryParams, body ImportStemmingDictionaryJSONRequestBody, reqEditors ...RequestEditorFn) (*ImportStemmingDictionaryResponse, error)
// GetStemmingDictionaryWithResponse request
GetStemmingDictionaryWithResponse(ctx context.Context, dictionaryId string, reqEditors ...RequestEditorFn) (*GetStemmingDictionaryResponse, error)
// RetrieveStopwordsSetsWithResponse request
RetrieveStopwordsSetsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RetrieveStopwordsSetsResponse, error)
// DeleteStopwordsSetWithResponse request
DeleteStopwordsSetWithResponse(ctx context.Context, setId string, reqEditors ...RequestEditorFn) (*DeleteStopwordsSetResponse, error)
// RetrieveStopwordsSetWithResponse request
RetrieveStopwordsSetWithResponse(ctx context.Context, setId string, reqEditors ...RequestEditorFn) (*RetrieveStopwordsSetResponse, error)
// UpsertStopwordsSetWithBodyWithResponse request with any body
UpsertStopwordsSetWithBodyWithResponse(ctx context.Context, setId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpsertStopwordsSetResponse, error)
UpsertStopwordsSetWithResponse(ctx context.Context, setId string, body UpsertStopwordsSetJSONRequestBody, reqEditors ...RequestEditorFn) (*UpsertStopwordsSetResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type CollectionAlias ¶
type CollectionAlias struct {
// CollectionName Name of the collection the alias mapped to
CollectionName string `json:"collection_name"`
// Name Name of the collection alias
Name *string `json:"name,omitempty"`
}
CollectionAlias defines model for CollectionAlias.
type CollectionAliasSchema ¶
type CollectionAliasSchema struct {
// CollectionName Name of the collection you wish to map the alias to
CollectionName string `json:"collection_name"`
}
CollectionAliasSchema defines model for CollectionAliasSchema.
type CollectionAliasesResponse ¶
type CollectionAliasesResponse struct {
Aliases []*CollectionAlias `json:"aliases"`
}
CollectionAliasesResponse defines model for CollectionAliasesResponse.
type CollectionResponse ¶
type CollectionResponse struct {
// CreatedAt Timestamp of when the collection was created (Unix epoch in seconds)
CreatedAt *int64 `json:"created_at,omitempty"`
// DefaultSortingField The name of an int32 / float field that determines the order in which the search results are ranked when a sort_by clause is not provided during searching. This field must indicate some kind of popularity.
DefaultSortingField *string `json:"default_sorting_field,omitempty"`
// EnableNestedFields Enables experimental support at a collection level for nested object or object array fields. This field is only available if the Typesense server is version `0.24.0.rcn34` or later.
EnableNestedFields *bool `json:"enable_nested_fields,omitempty"`
// Fields A list of fields for querying, filtering and faceting
Fields []Field `json:"fields"`
// Name Name of the collection
Name string `json:"name"`
// NumDocuments Number of documents in the collection
NumDocuments *int64 `json:"num_documents,omitempty"`
// SymbolsToIndex List of symbols or special characters to be indexed.
SymbolsToIndex *[]string `json:"symbols_to_index,omitempty"`
// TokenSeparators List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters.
TokenSeparators *[]string `json:"token_separators,omitempty"`
// VoiceQueryModel Configuration for the voice query model
VoiceQueryModel *VoiceQueryModelCollectionConfig `json:"voice_query_model,omitempty"`
}
CollectionResponse defines model for CollectionResponse.
type CollectionSchema ¶
type CollectionSchema struct {
// DefaultSortingField The name of an int32 / float field that determines the order in which the search results are ranked when a sort_by clause is not provided during searching. This field must indicate some kind of popularity.
DefaultSortingField *string `json:"default_sorting_field,omitempty"`
// EnableNestedFields Enables experimental support at a collection level for nested object or object array fields. This field is only available if the Typesense server is version `0.24.0.rcn34` or later.
EnableNestedFields *bool `json:"enable_nested_fields,omitempty"`
// Fields A list of fields for querying, filtering and faceting
Fields []Field `json:"fields"`
// Name Name of the collection
Name string `json:"name"`
// SymbolsToIndex List of symbols or special characters to be indexed.
SymbolsToIndex *[]string `json:"symbols_to_index,omitempty"`
// TokenSeparators List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters.
TokenSeparators *[]string `json:"token_separators,omitempty"`
// VoiceQueryModel Configuration for the voice query model
VoiceQueryModel *VoiceQueryModelCollectionConfig `json:"voice_query_model,omitempty"`
}
CollectionSchema defines model for CollectionSchema.
type CollectionUpdateSchema ¶
type CollectionUpdateSchema struct {
// Fields A list of fields for querying, filtering and faceting
Fields []Field `json:"fields"`
}
CollectionUpdateSchema defines model for CollectionUpdateSchema.
type ConversationModelCreateSchema ¶
type ConversationModelCreateSchema struct {
// AccountId LLM service's account ID (only applicable for Cloudflare)
AccountId *string `json:"account_id,omitempty"`
// ApiKey The LLM service's API Key
ApiKey *string `json:"api_key,omitempty"`
// HistoryCollection Typesense collection that stores the historical conversations
HistoryCollection string `json:"history_collection"`
// Id An explicit id for the model, otherwise the API will return a response with an auto-generated conversation model id.
Id *string `json:"id,omitempty"`
// MaxBytes The maximum number of bytes to send to the LLM in every API call. Consult the LLM's documentation on the number of bytes supported in the context window.
MaxBytes int `json:"max_bytes"`
// ModelName Name of the LLM model offered by OpenAI, Cloudflare or vLLM
ModelName string `json:"model_name"`
// SystemPrompt The system prompt that contains special instructions to the LLM
SystemPrompt *string `json:"system_prompt,omitempty"`
// Ttl Time interval in seconds after which the messages would be deleted. Default: 86400 (24 hours)
Ttl *int `json:"ttl,omitempty"`
// VllmUrl URL of vLLM service
VllmUrl *string `json:"vllm_url,omitempty"`
}
ConversationModelCreateSchema defines model for ConversationModelCreateSchema.
type ConversationModelSchema ¶
type ConversationModelSchema struct {
// AccountId LLM service's account ID (only applicable for Cloudflare)
AccountId *string `json:"account_id,omitempty"`
// ApiKey The LLM service's API Key
ApiKey *string `json:"api_key,omitempty"`
// HistoryCollection Typesense collection that stores the historical conversations
HistoryCollection string `json:"history_collection"`
// Id An explicit id for the model, otherwise the API will return a response with an auto-generated conversation model id.
Id string `json:"id"`
// MaxBytes The maximum number of bytes to send to the LLM in every API call. Consult the LLM's documentation on the number of bytes supported in the context window.
MaxBytes int `json:"max_bytes"`
// ModelName Name of the LLM model offered by OpenAI, Cloudflare or vLLM
ModelName string `json:"model_name"`
// SystemPrompt The system prompt that contains special instructions to the LLM
SystemPrompt *string `json:"system_prompt,omitempty"`
// Ttl Time interval in seconds after which the messages would be deleted. Default: 86400 (24 hours)
Ttl *int `json:"ttl,omitempty"`
// VllmUrl URL of vLLM service
VllmUrl *string `json:"vllm_url,omitempty"`
}
ConversationModelSchema defines model for ConversationModelSchema.
type ConversationModelUpdateSchema ¶
type ConversationModelUpdateSchema struct {
// AccountId LLM service's account ID (only applicable for Cloudflare)
AccountId *string `json:"account_id,omitempty"`
// ApiKey The LLM service's API Key
ApiKey *string `json:"api_key,omitempty"`
// HistoryCollection Typesense collection that stores the historical conversations
HistoryCollection *string `json:"history_collection,omitempty"`
// Id An explicit id for the model, otherwise the API will return a response with an auto-generated conversation model id.
Id *string `json:"id,omitempty"`
// MaxBytes The maximum number of bytes to send to the LLM in every API call. Consult the LLM's documentation on the number of bytes supported in the context window.
MaxBytes *int `json:"max_bytes,omitempty"`
// ModelName Name of the LLM model offered by OpenAI, Cloudflare or vLLM
ModelName *string `json:"model_name,omitempty"`
// SystemPrompt The system prompt that contains special instructions to the LLM
SystemPrompt *string `json:"system_prompt,omitempty"`
// Ttl Time interval in seconds after which the messages would be deleted. Default: 86400 (24 hours)
Ttl *int `json:"ttl,omitempty"`
// VllmUrl URL of vLLM service
VllmUrl *string `json:"vllm_url,omitempty"`
}
ConversationModelUpdateSchema defines model for ConversationModelUpdateSchema.
type CreateAnalyticsEventJSONRequestBody ¶
type CreateAnalyticsEventJSONRequestBody = AnalyticsEventCreateSchema
CreateAnalyticsEventJSONRequestBody defines body for CreateAnalyticsEvent for application/json ContentType.
type CreateAnalyticsEventResponse ¶
type CreateAnalyticsEventResponse struct {
Body []byte
HTTPResponse *http.Response
JSON201 *AnalyticsEventCreateResponse
JSON400 *ApiResponse
}
func ParseCreateAnalyticsEventResponse ¶
func ParseCreateAnalyticsEventResponse(rsp *http.Response) (*CreateAnalyticsEventResponse, error)
ParseCreateAnalyticsEventResponse parses an HTTP response from a CreateAnalyticsEventWithResponse call
func (CreateAnalyticsEventResponse) Status ¶
func (r CreateAnalyticsEventResponse) Status() string
Status returns HTTPResponse.Status
func (CreateAnalyticsEventResponse) StatusCode ¶
func (r CreateAnalyticsEventResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateAnalyticsRuleJSONRequestBody ¶
type CreateAnalyticsRuleJSONRequestBody = AnalyticsRuleSchema
CreateAnalyticsRuleJSONRequestBody defines body for CreateAnalyticsRule for application/json ContentType.
type CreateAnalyticsRuleResponse ¶
type CreateAnalyticsRuleResponse struct {
Body []byte
HTTPResponse *http.Response
JSON201 *AnalyticsRuleSchema
JSON400 *ApiResponse
}
func ParseCreateAnalyticsRuleResponse ¶
func ParseCreateAnalyticsRuleResponse(rsp *http.Response) (*CreateAnalyticsRuleResponse, error)
ParseCreateAnalyticsRuleResponse parses an HTTP response from a CreateAnalyticsRuleWithResponse call
func (CreateAnalyticsRuleResponse) Status ¶
func (r CreateAnalyticsRuleResponse) Status() string
Status returns HTTPResponse.Status
func (CreateAnalyticsRuleResponse) StatusCode ¶
func (r CreateAnalyticsRuleResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateCollectionJSONRequestBody ¶
type CreateCollectionJSONRequestBody = CollectionSchema
CreateCollectionJSONRequestBody defines body for CreateCollection for application/json ContentType.
type CreateCollectionResponse ¶
type CreateCollectionResponse struct {
Body []byte
HTTPResponse *http.Response
JSON201 *CollectionResponse
JSON400 *ApiResponse
JSON409 *ApiResponse
}
func ParseCreateCollectionResponse ¶
func ParseCreateCollectionResponse(rsp *http.Response) (*CreateCollectionResponse, error)
ParseCreateCollectionResponse parses an HTTP response from a CreateCollectionWithResponse call
func (CreateCollectionResponse) Status ¶
func (r CreateCollectionResponse) Status() string
Status returns HTTPResponse.Status
func (CreateCollectionResponse) StatusCode ¶
func (r CreateCollectionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateConversationModelJSONRequestBody ¶
type CreateConversationModelJSONRequestBody = ConversationModelCreateSchema
CreateConversationModelJSONRequestBody defines body for CreateConversationModel for application/json ContentType.
type CreateConversationModelResponse ¶
type CreateConversationModelResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ConversationModelSchema
JSON400 *ApiResponse
}
func ParseCreateConversationModelResponse ¶
func ParseCreateConversationModelResponse(rsp *http.Response) (*CreateConversationModelResponse, error)
ParseCreateConversationModelResponse parses an HTTP response from a CreateConversationModelWithResponse call
func (CreateConversationModelResponse) Status ¶
func (r CreateConversationModelResponse) Status() string
Status returns HTTPResponse.Status
func (CreateConversationModelResponse) StatusCode ¶
func (r CreateConversationModelResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateKeyJSONRequestBody ¶
type CreateKeyJSONRequestBody = ApiKeySchema
CreateKeyJSONRequestBody defines body for CreateKey for application/json ContentType.
type CreateKeyResponse ¶
type CreateKeyResponse struct {
Body []byte
HTTPResponse *http.Response
JSON201 *ApiKey
JSON400 *ApiResponse
JSON409 *ApiResponse
}
func ParseCreateKeyResponse ¶
func ParseCreateKeyResponse(rsp *http.Response) (*CreateKeyResponse, error)
ParseCreateKeyResponse parses an HTTP response from a CreateKeyWithResponse call
func (CreateKeyResponse) Status ¶
func (r CreateKeyResponse) Status() string
Status returns HTTPResponse.Status
func (CreateKeyResponse) StatusCode ¶
func (r CreateKeyResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DebugResponse ¶
type DebugResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Version *string `json:"version,omitempty"`
}
}
func ParseDebugResponse ¶
func ParseDebugResponse(rsp *http.Response) (*DebugResponse, error)
ParseDebugResponse parses an HTTP response from a DebugWithResponse call
func (DebugResponse) Status ¶
func (r DebugResponse) Status() string
Status returns HTTPResponse.Status
func (DebugResponse) StatusCode ¶
func (r DebugResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteAliasResponse ¶
type DeleteAliasResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CollectionAlias
JSON404 *ApiResponse
}
func ParseDeleteAliasResponse ¶
func ParseDeleteAliasResponse(rsp *http.Response) (*DeleteAliasResponse, error)
ParseDeleteAliasResponse parses an HTTP response from a DeleteAliasWithResponse call
func (DeleteAliasResponse) Status ¶
func (r DeleteAliasResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteAliasResponse) StatusCode ¶
func (r DeleteAliasResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteAnalyticsRuleResponse ¶
type DeleteAnalyticsRuleResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AnalyticsRuleDeleteResponse
JSON404 *ApiResponse
}
func ParseDeleteAnalyticsRuleResponse ¶
func ParseDeleteAnalyticsRuleResponse(rsp *http.Response) (*DeleteAnalyticsRuleResponse, error)
ParseDeleteAnalyticsRuleResponse parses an HTTP response from a DeleteAnalyticsRuleWithResponse call
func (DeleteAnalyticsRuleResponse) Status ¶
func (r DeleteAnalyticsRuleResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteAnalyticsRuleResponse) StatusCode ¶
func (r DeleteAnalyticsRuleResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteCollectionResponse ¶
type DeleteCollectionResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CollectionResponse
JSON404 *ApiResponse
}
func ParseDeleteCollectionResponse ¶
func ParseDeleteCollectionResponse(rsp *http.Response) (*DeleteCollectionResponse, error)
ParseDeleteCollectionResponse parses an HTTP response from a DeleteCollectionWithResponse call
func (DeleteCollectionResponse) Status ¶
func (r DeleteCollectionResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteCollectionResponse) StatusCode ¶
func (r DeleteCollectionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteConversationModelResponse ¶
type DeleteConversationModelResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ConversationModelSchema
}
func ParseDeleteConversationModelResponse ¶
func ParseDeleteConversationModelResponse(rsp *http.Response) (*DeleteConversationModelResponse, error)
ParseDeleteConversationModelResponse parses an HTTP response from a DeleteConversationModelWithResponse call
func (DeleteConversationModelResponse) Status ¶
func (r DeleteConversationModelResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteConversationModelResponse) StatusCode ¶
func (r DeleteConversationModelResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteDocumentResponse ¶
type DeleteDocumentResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *map[string]interface{}
JSON404 *ApiResponse
}
func ParseDeleteDocumentResponse ¶
func ParseDeleteDocumentResponse(rsp *http.Response) (*DeleteDocumentResponse, error)
ParseDeleteDocumentResponse parses an HTTP response from a DeleteDocumentWithResponse call
func (DeleteDocumentResponse) Status ¶
func (r DeleteDocumentResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteDocumentResponse) StatusCode ¶
func (r DeleteDocumentResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteDocumentsParams ¶
type DeleteDocumentsParams struct {
BatchSize *int `form:"batch_size,omitempty" json:"batch_size,omitempty"`
FilterBy *string `form:"filter_by,omitempty" json:"filter_by,omitempty"`
IgnoreNotFound *bool `form:"ignore_not_found,omitempty" json:"ignore_not_found,omitempty"`
Truncate *bool `form:"truncate,omitempty" json:"truncate,omitempty"`
}
DeleteDocumentsParams defines parameters for DeleteDocuments.
type DeleteDocumentsResponse ¶
type DeleteDocumentsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
NumDeleted int `json:"num_deleted"`
}
JSON404 *ApiResponse
}
func ParseDeleteDocumentsResponse ¶
func ParseDeleteDocumentsResponse(rsp *http.Response) (*DeleteDocumentsResponse, error)
ParseDeleteDocumentsResponse parses an HTTP response from a DeleteDocumentsWithResponse call
func (DeleteDocumentsResponse) Status ¶
func (r DeleteDocumentsResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteDocumentsResponse) StatusCode ¶
func (r DeleteDocumentsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteKeyResponse ¶
type DeleteKeyResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ApiKeyDeleteResponse
JSON400 *ApiResponse
JSON404 *ApiResponse
}
func ParseDeleteKeyResponse ¶
func ParseDeleteKeyResponse(rsp *http.Response) (*DeleteKeyResponse, error)
ParseDeleteKeyResponse parses an HTTP response from a DeleteKeyWithResponse call
func (DeleteKeyResponse) Status ¶
func (r DeleteKeyResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteKeyResponse) StatusCode ¶
func (r DeleteKeyResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeletePresetResponse ¶
type DeletePresetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *PresetDeleteSchema
JSON404 *ApiResponse
}
func ParseDeletePresetResponse ¶
func ParseDeletePresetResponse(rsp *http.Response) (*DeletePresetResponse, error)
ParseDeletePresetResponse parses an HTTP response from a DeletePresetWithResponse call
func (DeletePresetResponse) Status ¶
func (r DeletePresetResponse) Status() string
Status returns HTTPResponse.Status
func (DeletePresetResponse) StatusCode ¶
func (r DeletePresetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteSearchOverrideResponse ¶
type DeleteSearchOverrideResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SearchOverrideDeleteResponse
JSON404 *ApiResponse
}
func ParseDeleteSearchOverrideResponse ¶
func ParseDeleteSearchOverrideResponse(rsp *http.Response) (*DeleteSearchOverrideResponse, error)
ParseDeleteSearchOverrideResponse parses an HTTP response from a DeleteSearchOverrideWithResponse call
func (DeleteSearchOverrideResponse) Status ¶
func (r DeleteSearchOverrideResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteSearchOverrideResponse) StatusCode ¶
func (r DeleteSearchOverrideResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteSearchSynonymResponse ¶
type DeleteSearchSynonymResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SearchSynonymDeleteResponse
JSON404 *ApiResponse
}
func ParseDeleteSearchSynonymResponse ¶
func ParseDeleteSearchSynonymResponse(rsp *http.Response) (*DeleteSearchSynonymResponse, error)
ParseDeleteSearchSynonymResponse parses an HTTP response from a DeleteSearchSynonymWithResponse call
func (DeleteSearchSynonymResponse) Status ¶
func (r DeleteSearchSynonymResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteSearchSynonymResponse) StatusCode ¶
func (r DeleteSearchSynonymResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteStopwordsSetResponse ¶
type DeleteStopwordsSetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Id string `json:"id"`
}
JSON404 *ApiResponse
}
func ParseDeleteStopwordsSetResponse ¶
func ParseDeleteStopwordsSetResponse(rsp *http.Response) (*DeleteStopwordsSetResponse, error)
ParseDeleteStopwordsSetResponse parses an HTTP response from a DeleteStopwordsSetWithResponse call
func (DeleteStopwordsSetResponse) Status ¶
func (r DeleteStopwordsSetResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteStopwordsSetResponse) StatusCode ¶
func (r DeleteStopwordsSetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DirtyValues ¶
type DirtyValues string
DirtyValues defines model for DirtyValues.
const ( CoerceOrDrop DirtyValues = "coerce_or_drop" CoerceOrReject DirtyValues = "coerce_or_reject" Drop DirtyValues = "drop" Reject DirtyValues = "reject" )
Defines values for DirtyValues.
type DocumentIndexParameters ¶
type DocumentIndexParameters struct {
DirtyValues *DirtyValues `json:"dirty_values,omitempty"`
}
type DropTokensMode ¶
type DropTokensMode string
DropTokensMode Dictates the direction in which the words in the query must be dropped when the original words in the query do not appear in any document. Values: right_to_left (default), left_to_right, both_sides:3 A note on both_sides:3 - for queries upto 3 tokens (words) in length, this mode will drop tokens from both sides and exhaustively rank all matching results. If query length is greater than 3 words, Typesense will just fallback to default behavior of right_to_left
const ( BothSides3 DropTokensMode = "both_sides:3" LeftToRight DropTokensMode = "left_to_right" RightToLeft DropTokensMode = "right_to_left" )
Defines values for DropTokensMode.
type ExportDocumentsParams ¶
type ExportDocumentsParams struct {
ExcludeFields *string `form:"exclude_fields,omitempty" json:"exclude_fields,omitempty"`
FilterBy *string `form:"filter_by,omitempty" json:"filter_by,omitempty"`
IncludeFields *string `form:"include_fields,omitempty" json:"include_fields,omitempty"`
}
ExportDocumentsParams defines parameters for ExportDocuments.
type ExportDocumentsResponse ¶
type ExportDocumentsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON404 *ApiResponse
}
func ParseExportDocumentsResponse ¶
func ParseExportDocumentsResponse(rsp *http.Response) (*ExportDocumentsResponse, error)
ParseExportDocumentsResponse parses an HTTP response from a ExportDocumentsWithResponse call
func (ExportDocumentsResponse) Status ¶
func (r ExportDocumentsResponse) Status() string
Status returns HTTPResponse.Status
func (ExportDocumentsResponse) StatusCode ¶
func (r ExportDocumentsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FacetCounts ¶
type FacetCounts struct {
Counts *[]struct {
Count *int `json:"count,omitempty"`
Highlighted *string `json:"highlighted,omitempty"`
Parent *map[string]interface{} `json:"parent,omitempty"`
Value *string `json:"value,omitempty"`
} `json:"counts,omitempty"`
FieldName *string `json:"field_name,omitempty"`
Stats *struct {
Avg *float64 `json:"avg,omitempty"`
Max *float64 `json:"max,omitempty"`
Min *float64 `json:"min,omitempty"`
Sum *float64 `json:"sum,omitempty"`
TotalValues *int `json:"total_values,omitempty"`
} `json:"stats,omitempty"`
}
FacetCounts defines model for FacetCounts.
type Field ¶
type Field struct {
Drop *bool `json:"drop,omitempty"`
Embed *struct {
From []string `json:"from"`
ModelConfig struct {
AccessToken *string `json:"access_token,omitempty"`
ApiKey *string `json:"api_key,omitempty"`
ClientId *string `json:"client_id,omitempty"`
ClientSecret *string `json:"client_secret,omitempty"`
IndexingPrefix *string `json:"indexing_prefix,omitempty"`
ModelName string `json:"model_name"`
ProjectId *string `json:"project_id,omitempty"`
QueryPrefix *string `json:"query_prefix,omitempty"`
RefreshToken *string `json:"refresh_token,omitempty"`
Url *string `json:"url,omitempty"`
} `json:"model_config"`
} `json:"embed,omitempty"`
Facet *bool `json:"facet,omitempty"`
Index *bool `json:"index,omitempty"`
Infix *bool `json:"infix,omitempty"`
Locale *string `json:"locale,omitempty"`
Name string `json:"name"`
NumDim *int `json:"num_dim,omitempty"`
Optional *bool `json:"optional,omitempty"`
// RangeIndex Enables an index optimized for range filtering on numerical fields (e.g. rating:>3.5). Default: false.
RangeIndex *bool `json:"range_index,omitempty"`
// Reference Name of a field in another collection that should be linked to this collection so that it can be joined during query.
Reference *string `json:"reference,omitempty"`
Sort *bool `json:"sort,omitempty"`
// Stem Values are stemmed before indexing in-memory. Default: false.
Stem *bool `json:"stem,omitempty"`
// StemDictionary Name of the stemming dictionary to use for this field
StemDictionary *string `json:"stem_dictionary,omitempty"`
// Store When set to false, the field value will not be stored on disk. Default: true.
Store *bool `json:"store,omitempty"`
// SymbolsToIndex List of symbols or special characters to be indexed.
SymbolsToIndex *[]string `json:"symbols_to_index,omitempty"`
// TokenSeparators List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters.
TokenSeparators *[]string `json:"token_separators,omitempty"`
Type string `json:"type"`
// VecDist The distance metric to be used for vector search. Default: `cosine`. You can also use `ip` for inner product.
VecDist *string `json:"vec_dist,omitempty"`
}
Field defines model for Field.
type GetAliasResponse ¶
type GetAliasResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CollectionAlias
JSON404 *ApiResponse
}
func ParseGetAliasResponse ¶
func ParseGetAliasResponse(rsp *http.Response) (*GetAliasResponse, error)
ParseGetAliasResponse parses an HTTP response from a GetAliasWithResponse call
func (GetAliasResponse) Status ¶
func (r GetAliasResponse) Status() string
Status returns HTTPResponse.Status
func (GetAliasResponse) StatusCode ¶
func (r GetAliasResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetAliasesResponse ¶
type GetAliasesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CollectionAliasesResponse
}
func ParseGetAliasesResponse ¶
func ParseGetAliasesResponse(rsp *http.Response) (*GetAliasesResponse, error)
ParseGetAliasesResponse parses an HTTP response from a GetAliasesWithResponse call
func (GetAliasesResponse) Status ¶
func (r GetAliasesResponse) Status() string
Status returns HTTPResponse.Status
func (GetAliasesResponse) StatusCode ¶
func (r GetAliasesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetCollectionResponse ¶
type GetCollectionResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CollectionResponse
JSON404 *ApiResponse
}
func ParseGetCollectionResponse ¶
func ParseGetCollectionResponse(rsp *http.Response) (*GetCollectionResponse, error)
ParseGetCollectionResponse parses an HTTP response from a GetCollectionWithResponse call
func (GetCollectionResponse) Status ¶
func (r GetCollectionResponse) Status() string
Status returns HTTPResponse.Status
func (GetCollectionResponse) StatusCode ¶
func (r GetCollectionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetCollectionsResponse ¶
type GetCollectionsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]*CollectionResponse
}
func ParseGetCollectionsResponse ¶
func ParseGetCollectionsResponse(rsp *http.Response) (*GetCollectionsResponse, error)
ParseGetCollectionsResponse parses an HTTP response from a GetCollectionsWithResponse call
func (GetCollectionsResponse) Status ¶
func (r GetCollectionsResponse) Status() string
Status returns HTTPResponse.Status
func (GetCollectionsResponse) StatusCode ¶
func (r GetCollectionsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetDocumentResponse ¶
type GetDocumentResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *map[string]interface{}
JSON404 *ApiResponse
}
func ParseGetDocumentResponse ¶
func ParseGetDocumentResponse(rsp *http.Response) (*GetDocumentResponse, error)
ParseGetDocumentResponse parses an HTTP response from a GetDocumentWithResponse call
func (GetDocumentResponse) Status ¶
func (r GetDocumentResponse) Status() string
Status returns HTTPResponse.Status
func (GetDocumentResponse) StatusCode ¶
func (r GetDocumentResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetKeyResponse ¶
type GetKeyResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ApiKey
JSON404 *ApiResponse
}
func ParseGetKeyResponse ¶
func ParseGetKeyResponse(rsp *http.Response) (*GetKeyResponse, error)
ParseGetKeyResponse parses an HTTP response from a GetKeyWithResponse call
func (GetKeyResponse) Status ¶
func (r GetKeyResponse) Status() string
Status returns HTTPResponse.Status
func (GetKeyResponse) StatusCode ¶
func (r GetKeyResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetKeysResponse ¶
type GetKeysResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ApiKeysResponse
}
func ParseGetKeysResponse ¶
func ParseGetKeysResponse(rsp *http.Response) (*GetKeysResponse, error)
ParseGetKeysResponse parses an HTTP response from a GetKeysWithResponse call
func (GetKeysResponse) Status ¶
func (r GetKeysResponse) Status() string
Status returns HTTPResponse.Status
func (GetKeysResponse) StatusCode ¶
func (r GetKeysResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetSchemaChangesResponse ¶
type GetSchemaChangesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]SchemaChangeStatus
}
func ParseGetSchemaChangesResponse ¶
func ParseGetSchemaChangesResponse(rsp *http.Response) (*GetSchemaChangesResponse, error)
ParseGetSchemaChangesResponse parses an HTTP response from a GetSchemaChangesWithResponse call
func (GetSchemaChangesResponse) Status ¶
func (r GetSchemaChangesResponse) Status() string
Status returns HTTPResponse.Status
func (GetSchemaChangesResponse) StatusCode ¶
func (r GetSchemaChangesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetSearchOverrideResponse ¶
type GetSearchOverrideResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SearchOverride
}
func ParseGetSearchOverrideResponse ¶
func ParseGetSearchOverrideResponse(rsp *http.Response) (*GetSearchOverrideResponse, error)
ParseGetSearchOverrideResponse parses an HTTP response from a GetSearchOverrideWithResponse call
func (GetSearchOverrideResponse) Status ¶
func (r GetSearchOverrideResponse) Status() string
Status returns HTTPResponse.Status
func (GetSearchOverrideResponse) StatusCode ¶
func (r GetSearchOverrideResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetSearchOverridesResponse ¶
type GetSearchOverridesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SearchOverridesResponse
}
func ParseGetSearchOverridesResponse ¶
func ParseGetSearchOverridesResponse(rsp *http.Response) (*GetSearchOverridesResponse, error)
ParseGetSearchOverridesResponse parses an HTTP response from a GetSearchOverridesWithResponse call
func (GetSearchOverridesResponse) Status ¶
func (r GetSearchOverridesResponse) Status() string
Status returns HTTPResponse.Status
func (GetSearchOverridesResponse) StatusCode ¶
func (r GetSearchOverridesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetSearchSynonymResponse ¶
type GetSearchSynonymResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SearchSynonym
JSON404 *ApiResponse
}
func ParseGetSearchSynonymResponse ¶
func ParseGetSearchSynonymResponse(rsp *http.Response) (*GetSearchSynonymResponse, error)
ParseGetSearchSynonymResponse parses an HTTP response from a GetSearchSynonymWithResponse call
func (GetSearchSynonymResponse) Status ¶
func (r GetSearchSynonymResponse) Status() string
Status returns HTTPResponse.Status
func (GetSearchSynonymResponse) StatusCode ¶
func (r GetSearchSynonymResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetSearchSynonymsResponse ¶
type GetSearchSynonymsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SearchSynonymsResponse
JSON404 *ApiResponse
}
func ParseGetSearchSynonymsResponse ¶
func ParseGetSearchSynonymsResponse(rsp *http.Response) (*GetSearchSynonymsResponse, error)
ParseGetSearchSynonymsResponse parses an HTTP response from a GetSearchSynonymsWithResponse call
func (GetSearchSynonymsResponse) Status ¶
func (r GetSearchSynonymsResponse) Status() string
Status returns HTTPResponse.Status
func (GetSearchSynonymsResponse) StatusCode ¶
func (r GetSearchSynonymsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetStemmingDictionaryResponse ¶
type GetStemmingDictionaryResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *StemmingDictionary
JSON404 *ApiResponse
}
func ParseGetStemmingDictionaryResponse ¶
func ParseGetStemmingDictionaryResponse(rsp *http.Response) (*GetStemmingDictionaryResponse, error)
ParseGetStemmingDictionaryResponse parses an HTTP response from a GetStemmingDictionaryWithResponse call
func (GetStemmingDictionaryResponse) Status ¶
func (r GetStemmingDictionaryResponse) Status() string
Status returns HTTPResponse.Status
func (GetStemmingDictionaryResponse) StatusCode ¶
func (r GetStemmingDictionaryResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HealthResponse ¶
type HealthResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *HealthStatus
}
func ParseHealthResponse ¶
func ParseHealthResponse(rsp *http.Response) (*HealthResponse, error)
ParseHealthResponse parses an HTTP response from a HealthWithResponse call
func (HealthResponse) Status ¶
func (r HealthResponse) Status() string
Status returns HTTPResponse.Status
func (HealthResponse) StatusCode ¶
func (r HealthResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HealthStatus ¶
type HealthStatus struct {
Ok bool `json:"ok"`
}
HealthStatus defines model for HealthStatus.
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type ImportDocumentResponse ¶
type ImportDocumentsParams ¶
type ImportDocumentsParams struct {
Action *IndexAction `form:"action,omitempty" json:"action,omitempty"`
BatchSize *int `form:"batch_size,omitempty" json:"batch_size,omitempty"`
DirtyValues *DirtyValues `form:"dirty_values,omitempty" json:"dirty_values,omitempty"`
RemoteEmbeddingBatchSize *int `form:"remote_embedding_batch_size,omitempty" json:"remote_embedding_batch_size,omitempty"`
ReturnDoc *bool `form:"return_doc,omitempty" json:"return_doc,omitempty"`
ReturnId *bool `form:"return_id,omitempty" json:"return_id,omitempty"`
}
ImportDocumentsParams defines parameters for ImportDocuments.
type ImportDocumentsResponse ¶
type ImportDocumentsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON400 *ApiResponse
JSON404 *ApiResponse
}
func ParseImportDocumentsResponse ¶
func ParseImportDocumentsResponse(rsp *http.Response) (*ImportDocumentsResponse, error)
ParseImportDocumentsResponse parses an HTTP response from a ImportDocumentsWithResponse call
func (ImportDocumentsResponse) Status ¶
func (r ImportDocumentsResponse) Status() string
Status returns HTTPResponse.Status
func (ImportDocumentsResponse) StatusCode ¶
func (r ImportDocumentsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ImportStemmingDictionaryJSONBody ¶
type ImportStemmingDictionaryJSONBody = string
ImportStemmingDictionaryJSONBody defines parameters for ImportStemmingDictionary.
type ImportStemmingDictionaryJSONRequestBody ¶
type ImportStemmingDictionaryJSONRequestBody = ImportStemmingDictionaryJSONBody
ImportStemmingDictionaryJSONRequestBody defines body for ImportStemmingDictionary for application/json ContentType.
type ImportStemmingDictionaryParams ¶
type ImportStemmingDictionaryParams struct {
// Id The ID to assign to the dictionary
Id string `form:"id" json:"id"`
}
ImportStemmingDictionaryParams defines parameters for ImportStemmingDictionary.
type ImportStemmingDictionaryResponse ¶
type ImportStemmingDictionaryResponse struct {
Body []byte
HTTPResponse *http.Response
JSON400 *ApiResponse
}
func ParseImportStemmingDictionaryResponse ¶
func ParseImportStemmingDictionaryResponse(rsp *http.Response) (*ImportStemmingDictionaryResponse, error)
ParseImportStemmingDictionaryResponse parses an HTTP response from a ImportStemmingDictionaryWithResponse call
func (ImportStemmingDictionaryResponse) Status ¶
func (r ImportStemmingDictionaryResponse) Status() string
Status returns HTTPResponse.Status
func (ImportStemmingDictionaryResponse) StatusCode ¶
func (r ImportStemmingDictionaryResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type IndexAction ¶
type IndexAction string
IndexAction defines model for IndexAction.
const ( Create IndexAction = "create" Emplace IndexAction = "emplace" Update IndexAction = "update" Upsert IndexAction = "upsert" )
Defines values for IndexAction.
type IndexDocumentJSONBody ¶
type IndexDocumentJSONBody = interface{}
IndexDocumentJSONBody defines parameters for IndexDocument.
type IndexDocumentJSONRequestBody ¶
type IndexDocumentJSONRequestBody = IndexDocumentJSONBody
IndexDocumentJSONRequestBody defines body for IndexDocument for application/json ContentType.
type IndexDocumentParams ¶
type IndexDocumentParams struct {
// Action Additional action to perform
Action *IndexAction `form:"action,omitempty" json:"action,omitempty"`
// DirtyValues Dealing with Dirty Data
DirtyValues *DirtyValues `form:"dirty_values,omitempty" json:"dirty_values,omitempty"`
}
IndexDocumentParams defines parameters for IndexDocument.
type IndexDocumentResponse ¶
type IndexDocumentResponse struct {
Body []byte
HTTPResponse *http.Response
JSON201 *map[string]interface{}
JSON404 *ApiResponse
}
func ParseIndexDocumentResponse ¶
func ParseIndexDocumentResponse(rsp *http.Response) (*IndexDocumentResponse, error)
ParseIndexDocumentResponse parses an HTTP response from a IndexDocumentWithResponse call
func (IndexDocumentResponse) Status ¶
func (r IndexDocumentResponse) Status() string
Status returns HTTPResponse.Status
func (IndexDocumentResponse) StatusCode ¶
func (r IndexDocumentResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListStemmingDictionariesResponse ¶
type ListStemmingDictionariesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Dictionaries *[]string `json:"dictionaries,omitempty"`
}
}
func ParseListStemmingDictionariesResponse ¶
func ParseListStemmingDictionariesResponse(rsp *http.Response) (*ListStemmingDictionariesResponse, error)
ParseListStemmingDictionariesResponse parses an HTTP response from a ListStemmingDictionariesWithResponse call
func (ListStemmingDictionariesResponse) Status ¶
func (r ListStemmingDictionariesResponse) Status() string
Status returns HTTPResponse.Status
func (ListStemmingDictionariesResponse) StatusCode ¶
func (r ListStemmingDictionariesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type MultiSearchCollectionParameters ¶
type MultiSearchCollectionParameters struct {
// CacheTtl The duration (in seconds) that determines how long the search query is cached. This value can be set on a per-query basis. Default: 60.
CacheTtl *int `json:"cache_ttl,omitempty"`
// Collection The collection to search in.
Collection *string `json:"collection,omitempty"`
// Conversation Enable conversational search.
Conversation *bool `json:"conversation,omitempty"`
// ConversationId The Id of a previous conversation to continue, this tells Typesense to include prior context when communicating with the LLM.
ConversationId *string `json:"conversation_id,omitempty"`
// ConversationModelId The Id of Conversation Model to be used.
ConversationModelId *string `json:"conversation_model_id,omitempty"`
// DropTokensMode Dictates the direction in which the words in the query must be dropped when the original words in the query do not appear in any document. Values: right_to_left (default), left_to_right, both_sides:3 A note on both_sides:3 - for queries upto 3 tokens (words) in length, this mode will drop tokens from both sides and exhaustively rank all matching results. If query length is greater than 3 words, Typesense will just fallback to default behavior of right_to_left
DropTokensMode *DropTokensMode `json:"drop_tokens_mode,omitempty"`
// DropTokensThreshold If the number of results found for a specific query is less than this number, Typesense will attempt to drop the tokens in the query until enough results are found. Tokens that have the least individual hits are dropped first. Set to 0 to disable. Default: 10
DropTokensThreshold *int `json:"drop_tokens_threshold,omitempty"`
// EnableOverrides If you have some overrides defined but want to disable all of them during query time, you can do that by setting this parameter to false
EnableOverrides *bool `json:"enable_overrides,omitempty"`
// EnableSynonyms If you have some synonyms defined but want to disable all of them for a particular search query, set enable_synonyms to false. Default: true
EnableSynonyms *bool `json:"enable_synonyms,omitempty"`
// EnableTyposForAlphaNumericalTokens Set this parameter to false to disable typos on alphanumerical query tokens. Default: true.
EnableTyposForAlphaNumericalTokens *bool `json:"enable_typos_for_alpha_numerical_tokens,omitempty"`
// EnableTyposForNumericalTokens Make Typesense disable typos for numerical tokens.
EnableTyposForNumericalTokens *bool `json:"enable_typos_for_numerical_tokens,omitempty"`
// ExcludeFields List of fields from the document to exclude in the search result
ExcludeFields *string `json:"exclude_fields,omitempty"`
// ExhaustiveSearch Setting this to true will make Typesense consider all prefixes and typo corrections of the words in the query without stopping early when enough results are found (drop_tokens_threshold and typo_tokens_threshold configurations are ignored).
ExhaustiveSearch *bool `json:"exhaustive_search,omitempty"`
// FacetBy A list of fields that will be used for faceting your results on. Separate multiple fields with a comma.
FacetBy *string `json:"facet_by,omitempty"`
// FacetQuery Facet values that are returned can now be filtered via this parameter. The matching facet text is also highlighted. For example, when faceting by `category`, you can set `facet_query=category:shoe` to return only facet values that contain the prefix "shoe".
FacetQuery *string `json:"facet_query,omitempty"`
// FacetReturnParent Comma separated string of nested facet fields whose parent object should be returned in facet response.
FacetReturnParent *string `json:"facet_return_parent,omitempty"`
// FacetStrategy Choose the underlying faceting strategy used. Comma separated string of allows values: exhaustive, top_values or automatic (default).
FacetStrategy *string `json:"facet_strategy,omitempty"`
// FilterBy Filter conditions for refining youropen api validator search results. Separate multiple conditions with &&.
FilterBy *string `json:"filter_by,omitempty"`
// FilterCuratedHits Whether the filter_by condition of the search query should be applicable to curated results (override definitions, pinned hits, hidden hits, etc.). Default: false
FilterCuratedHits *bool `json:"filter_curated_hits,omitempty"`
// GroupBy You can aggregate search results into groups or buckets by specify one or more `group_by` fields. Separate multiple fields with a comma. To group on a particular field, it must be a faceted field.
GroupBy *string `json:"group_by,omitempty"`
// GroupLimit Maximum number of hits to be returned for every group. If the `group_limit` is set as `K` then only the top K hits in each group are returned in the response. Default: 3
GroupLimit *int `json:"group_limit,omitempty"`
// GroupMissingValues Setting this parameter to true will place all documents that have a null value in the group_by field, into a single group. Setting this parameter to false, will cause each document with a null value in the group_by field to not be grouped with other documents. Default: true
GroupMissingValues *bool `json:"group_missing_values,omitempty"`
// HiddenHits A list of records to unconditionally hide from search results. A list of `record_id`s to hide. Eg: to hide records with IDs 123 and 456, you'd specify `123,456`.
// You could also use the Overrides feature to override search results based on rules. Overrides are applied first, followed by `pinned_hits` and finally `hidden_hits`.
HiddenHits *string `json:"hidden_hits,omitempty"`
// HighlightAffixNumTokens The number of tokens that should surround the highlighted text on each side. Default: 4
HighlightAffixNumTokens *int `json:"highlight_affix_num_tokens,omitempty"`
// HighlightEndTag The end tag used for the highlighted snippets. Default: `</mark>`
HighlightEndTag *string `json:"highlight_end_tag,omitempty"`
// HighlightFields A list of custom fields that must be highlighted even if you don't query for them
HighlightFields *string `json:"highlight_fields,omitempty"`
// HighlightFullFields List of fields which should be highlighted fully without snippeting
HighlightFullFields *string `json:"highlight_full_fields,omitempty"`
// HighlightStartTag The start tag used for the highlighted snippets. Default: `<mark>`
HighlightStartTag *string `json:"highlight_start_tag,omitempty"`
// IncludeFields List of fields from the document to include in the search result
IncludeFields *string `json:"include_fields,omitempty"`
// Infix If infix index is enabled for this field, infix searching can be done on a per-field basis by sending a comma separated string parameter called infix to the search query. This parameter can have 3 values; `off` infix search is disabled, which is default `always` infix search is performed along with regular search `fallback` infix search is performed if regular search does not produce results
Infix *string `json:"infix,omitempty"`
// Limit Number of hits to fetch. Can be used as an alternative to the per_page parameter. Default: 10.
Limit *int `json:"limit,omitempty"`
// MaxExtraPrefix There are also 2 parameters that allow you to control the extent of infix searching max_extra_prefix and max_extra_suffix which specify the maximum number of symbols before or after the query that can be present in the token. For example query "K2100" has 2 extra symbols in "6PK2100". By default, any number of prefixes/suffixes can be present for a match.
MaxExtraPrefix *int `json:"max_extra_prefix,omitempty"`
// MaxExtraSuffix There are also 2 parameters that allow you to control the extent of infix searching max_extra_prefix and max_extra_suffix which specify the maximum number of symbols before or after the query that can be present in the token. For example query "K2100" has 2 extra symbols in "6PK2100". By default, any number of prefixes/suffixes can be present for a match.
MaxExtraSuffix *int `json:"max_extra_suffix,omitempty"`
// MaxFacetValues Maximum number of facet values to be returned.
MaxFacetValues *int `json:"max_facet_values,omitempty"`
// MinLen1typo Minimum word length for 1-typo correction to be applied. The value of num_typos is still treated as the maximum allowed typos.
MinLen1typo *int `json:"min_len_1typo,omitempty"`
// MinLen2typo Minimum word length for 2-typo correction to be applied. The value of num_typos is still treated as the maximum allowed typos.
MinLen2typo *int `json:"min_len_2typo,omitempty"`
// NumTypos The number of typographical errors (1 or 2) that would be tolerated. Default: 2
NumTypos *string `json:"num_typos,omitempty"`
// Offset Identifies the starting point to return hits from a result set. Can be used as an alternative to the page parameter.
Offset *int `json:"offset,omitempty"`
// OverrideTags Comma separated list of tags to trigger the curations rules that match the tags.
OverrideTags *string `json:"override_tags,omitempty"`
// Page Results from this specific page number would be fetched.
Page *int `json:"page,omitempty"`
// PerPage Number of results to fetch per page. Default: 10
PerPage *int `json:"per_page,omitempty"`
// PinnedHits A list of records to unconditionally include in the search results at specific positions. An example use case would be to feature or promote certain items on the top of search results. A list of `record_id:hit_position`. Eg: to include a record with ID 123 at Position 1 and another record with ID 456 at Position 5, you'd specify `123:1,456:5`.
// You could also use the Overrides feature to override search results based on rules. Overrides are applied first, followed by `pinned_hits` and finally `hidden_hits`.
PinnedHits *string `json:"pinned_hits,omitempty"`
// PreSegmentedQuery You can index content from any logographic language into Typesense if you are able to segment / split the text into space-separated words yourself before indexing and querying.
// Set this parameter to true to do the same
PreSegmentedQuery *bool `json:"pre_segmented_query,omitempty"`
// Prefix Boolean field to indicate that the last word in the query should be treated as a prefix, and not as a whole word. This is used for building autocomplete and instant search interfaces. Defaults to true.
Prefix *string `json:"prefix,omitempty"`
// Preset Search using a bunch of search parameters by setting this parameter to the name of the existing Preset.
Preset *string `json:"preset,omitempty"`
// PrioritizeExactMatch Set this parameter to true to ensure that an exact match is ranked above the others
PrioritizeExactMatch *bool `json:"prioritize_exact_match,omitempty"`
// PrioritizeNumMatchingFields Make Typesense prioritize documents where the query words appear in more number of fields.
PrioritizeNumMatchingFields *bool `json:"prioritize_num_matching_fields,omitempty"`
// PrioritizeTokenPosition Make Typesense prioritize documents where the query words appear earlier in the text.
PrioritizeTokenPosition *bool `json:"prioritize_token_position,omitempty"`
// Q The query text to search for in the collection. Use * as the search string to return all documents. This is typically useful when used in conjunction with filter_by.
Q *string `json:"q,omitempty"`
// QueryBy A list of `string` fields that should be queried against. Multiple fields are separated with a comma.
QueryBy *string `json:"query_by,omitempty"`
// QueryByWeights The relative weight to give each `query_by` field when ranking results. This can be used to boost fields in priority, when looking for matches. Multiple fields are separated with a comma.
QueryByWeights *string `json:"query_by_weights,omitempty"`
// RemoteEmbeddingNumTries Number of times to retry fetching remote embeddings.
RemoteEmbeddingNumTries *int `json:"remote_embedding_num_tries,omitempty"`
// RemoteEmbeddingTimeoutMs Timeout (in milliseconds) for fetching remote embeddings.
RemoteEmbeddingTimeoutMs *int `json:"remote_embedding_timeout_ms,omitempty"`
// RerankHybridMatches When true, computes both text match and vector distance scores for all matches in hybrid search. Documents found only through keyword search will get a vector distance score, and documents found only through vector search will get a text match score.
RerankHybridMatches *bool `json:"rerank_hybrid_matches,omitempty"`
// SearchCutoffMs Typesense will attempt to return results early if the cutoff time has elapsed. This is not a strict guarantee and facet computation is not bound by this parameter.
SearchCutoffMs *int `json:"search_cutoff_ms,omitempty"`
// SnippetThreshold Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion. Default: 30
SnippetThreshold *int `json:"snippet_threshold,omitempty"`
// SortBy A list of numerical fields and their corresponding sort orders that will be used for ordering your results. Up to 3 sort fields can be specified. The text similarity score is exposed as a special `_text_match` field that you can use in the list of sorting fields. If no `sort_by` parameter is specified, results are sorted by `_text_match:desc,default_sorting_field:desc`
SortBy *string `json:"sort_by,omitempty"`
// Stopwords Name of the stopwords set to apply for this search, the keywords present in the set will be removed from the search query.
Stopwords *string `json:"stopwords,omitempty"`
// SynonymNumTypos Allow synonym resolution on typo-corrected words in the query. Default: 0
SynonymNumTypos *int `json:"synonym_num_typos,omitempty"`
// SynonymPrefix Allow synonym resolution on word prefixes in the query. Default: false
SynonymPrefix *bool `json:"synonym_prefix,omitempty"`
// TextMatchType In a multi-field matching context, this parameter determines how the representative text match score of a record is calculated. Possible values are max_score (default) or max_weight.
TextMatchType *string `json:"text_match_type,omitempty"`
// TypoTokensThreshold If the number of results found for a specific query is less than this number, Typesense will attempt to look for tokens with more typos until enough results are found. Default: 100
TypoTokensThreshold *int `json:"typo_tokens_threshold,omitempty"`
// UseCache Enable server side caching of search query results. By default, caching is disabled.
UseCache *bool `json:"use_cache,omitempty"`
// VectorQuery Vector query expression for fetching documents "closest" to a given query/document vector.
VectorQuery *string `json:"vector_query,omitempty"`
// VoiceQuery The base64 encoded audio file in 16 khz 16-bit WAV format.
VoiceQuery *string `json:"voice_query,omitempty"`
// XTypesenseApiKey A separate search API key for each search within a multi_search request
XTypesenseApiKey *string `json:"x-typesense-api-key,omitempty"`
}
MultiSearchCollectionParameters defines model for MultiSearchCollectionParameters.
type MultiSearchJSONRequestBody ¶
type MultiSearchJSONRequestBody = MultiSearchSearchesParameter
MultiSearchJSONRequestBody defines body for MultiSearch for application/json ContentType.
type MultiSearchParameters ¶
type MultiSearchParameters struct {
// CacheTtl The duration (in seconds) that determines how long the search query is cached. This value can be set on a per-query basis. Default: 60.
CacheTtl *int `json:"cache_ttl,omitempty"`
// Conversation Enable conversational search.
Conversation *bool `json:"conversation,omitempty"`
// ConversationId The Id of a previous conversation to continue, this tells Typesense to include prior context when communicating with the LLM.
ConversationId *string `json:"conversation_id,omitempty"`
// ConversationModelId The Id of Conversation Model to be used.
ConversationModelId *string `json:"conversation_model_id,omitempty"`
// DropTokensMode Dictates the direction in which the words in the query must be dropped when the original words in the query do not appear in any document. Values: right_to_left (default), left_to_right, both_sides:3 A note on both_sides:3 - for queries upto 3 tokens (words) in length, this mode will drop tokens from both sides and exhaustively rank all matching results. If query length is greater than 3 words, Typesense will just fallback to default behavior of right_to_left
DropTokensMode *DropTokensMode `json:"drop_tokens_mode,omitempty"`
// DropTokensThreshold If the number of results found for a specific query is less than this number, Typesense will attempt to drop the tokens in the query until enough results are found. Tokens that have the least individual hits are dropped first. Set to 0 to disable. Default: 10
DropTokensThreshold *int `json:"drop_tokens_threshold,omitempty"`
// EnableOverrides If you have some overrides defined but want to disable all of them during query time, you can do that by setting this parameter to false
EnableOverrides *bool `json:"enable_overrides,omitempty"`
// EnableSynonyms If you have some synonyms defined but want to disable all of them for a particular search query, set enable_synonyms to false. Default: true
EnableSynonyms *bool `json:"enable_synonyms,omitempty"`
// EnableTyposForAlphaNumericalTokens Set this parameter to false to disable typos on alphanumerical query tokens. Default: true.
EnableTyposForAlphaNumericalTokens *bool `json:"enable_typos_for_alpha_numerical_tokens,omitempty"`
// EnableTyposForNumericalTokens Make Typesense disable typos for numerical tokens.
EnableTyposForNumericalTokens *bool `json:"enable_typos_for_numerical_tokens,omitempty"`
// ExcludeFields List of fields from the document to exclude in the search result
ExcludeFields *string `json:"exclude_fields,omitempty"`
// ExhaustiveSearch Setting this to true will make Typesense consider all prefixes and typo corrections of the words in the query without stopping early when enough results are found (drop_tokens_threshold and typo_tokens_threshold configurations are ignored).
ExhaustiveSearch *bool `json:"exhaustive_search,omitempty"`
// FacetBy A list of fields that will be used for faceting your results on. Separate multiple fields with a comma.
FacetBy *string `json:"facet_by,omitempty"`
// FacetQuery Facet values that are returned can now be filtered via this parameter. The matching facet text is also highlighted. For example, when faceting by `category`, you can set `facet_query=category:shoe` to return only facet values that contain the prefix "shoe".
FacetQuery *string `json:"facet_query,omitempty"`
// FacetReturnParent Comma separated string of nested facet fields whose parent object should be returned in facet response.
FacetReturnParent *string `json:"facet_return_parent,omitempty"`
// FacetStrategy Choose the underlying faceting strategy used. Comma separated string of allows values: exhaustive, top_values or automatic (default).
FacetStrategy *string `json:"facet_strategy,omitempty"`
// FilterBy Filter conditions for refining youropen api validator search results. Separate multiple conditions with &&.
FilterBy *string `json:"filter_by,omitempty"`
// FilterCuratedHits Whether the filter_by condition of the search query should be applicable to curated results (override definitions, pinned hits, hidden hits, etc.). Default: false
FilterCuratedHits *bool `json:"filter_curated_hits,omitempty"`
// GroupBy You can aggregate search results into groups or buckets by specify one or more `group_by` fields. Separate multiple fields with a comma. To group on a particular field, it must be a faceted field.
GroupBy *string `json:"group_by,omitempty"`
// GroupLimit Maximum number of hits to be returned for every group. If the `group_limit` is set as `K` then only the top K hits in each group are returned in the response. Default: 3
GroupLimit *int `json:"group_limit,omitempty"`
// GroupMissingValues Setting this parameter to true will place all documents that have a null value in the group_by field, into a single group. Setting this parameter to false, will cause each document with a null value in the group_by field to not be grouped with other documents. Default: true
GroupMissingValues *bool `json:"group_missing_values,omitempty"`
// HiddenHits A list of records to unconditionally hide from search results. A list of `record_id`s to hide. Eg: to hide records with IDs 123 and 456, you'd specify `123,456`.
// You could also use the Overrides feature to override search results based on rules. Overrides are applied first, followed by `pinned_hits` and finally `hidden_hits`.
HiddenHits *string `json:"hidden_hits,omitempty"`
// HighlightAffixNumTokens The number of tokens that should surround the highlighted text on each side. Default: 4
HighlightAffixNumTokens *int `json:"highlight_affix_num_tokens,omitempty"`
// HighlightEndTag The end tag used for the highlighted snippets. Default: `</mark>`
HighlightEndTag *string `json:"highlight_end_tag,omitempty"`
// HighlightFields A list of custom fields that must be highlighted even if you don't query for them
HighlightFields *string `json:"highlight_fields,omitempty"`
// HighlightFullFields List of fields which should be highlighted fully without snippeting
HighlightFullFields *string `json:"highlight_full_fields,omitempty"`
// HighlightStartTag The start tag used for the highlighted snippets. Default: `<mark>`
HighlightStartTag *string `json:"highlight_start_tag,omitempty"`
// IncludeFields List of fields from the document to include in the search result
IncludeFields *string `json:"include_fields,omitempty"`
// Infix If infix index is enabled for this field, infix searching can be done on a per-field basis by sending a comma separated string parameter called infix to the search query. This parameter can have 3 values; `off` infix search is disabled, which is default `always` infix search is performed along with regular search `fallback` infix search is performed if regular search does not produce results
Infix *string `json:"infix,omitempty"`
// Limit Number of hits to fetch. Can be used as an alternative to the per_page parameter. Default: 10.
Limit *int `json:"limit,omitempty"`
// MaxExtraPrefix There are also 2 parameters that allow you to control the extent of infix searching max_extra_prefix and max_extra_suffix which specify the maximum number of symbols before or after the query that can be present in the token. For example query "K2100" has 2 extra symbols in "6PK2100". By default, any number of prefixes/suffixes can be present for a match.
MaxExtraPrefix *int `json:"max_extra_prefix,omitempty"`
// MaxExtraSuffix There are also 2 parameters that allow you to control the extent of infix searching max_extra_prefix and max_extra_suffix which specify the maximum number of symbols before or after the query that can be present in the token. For example query "K2100" has 2 extra symbols in "6PK2100". By default, any number of prefixes/suffixes can be present for a match.
MaxExtraSuffix *int `json:"max_extra_suffix,omitempty"`
// MaxFacetValues Maximum number of facet values to be returned.
MaxFacetValues *int `json:"max_facet_values,omitempty"`
// MinLen1typo Minimum word length for 1-typo correction to be applied. The value of num_typos is still treated as the maximum allowed typos.
MinLen1typo *int `json:"min_len_1typo,omitempty"`
// MinLen2typo Minimum word length for 2-typo correction to be applied. The value of num_typos is still treated as the maximum allowed typos.
MinLen2typo *int `json:"min_len_2typo,omitempty"`
// NumTypos The number of typographical errors (1 or 2) that would be tolerated. Default: 2
NumTypos *string `json:"num_typos,omitempty"`
// Offset Identifies the starting point to return hits from a result set. Can be used as an alternative to the page parameter.
Offset *int `json:"offset,omitempty"`
// OverrideTags Comma separated list of tags to trigger the curations rules that match the tags.
OverrideTags *string `json:"override_tags,omitempty"`
// Page Results from this specific page number would be fetched.
Page *int `json:"page,omitempty"`
// PerPage Number of results to fetch per page. Default: 10
PerPage *int `json:"per_page,omitempty"`
// PinnedHits A list of records to unconditionally include in the search results at specific positions. An example use case would be to feature or promote certain items on the top of search results. A list of `record_id:hit_position`. Eg: to include a record with ID 123 at Position 1 and another record with ID 456 at Position 5, you'd specify `123:1,456:5`.
// You could also use the Overrides feature to override search results based on rules. Overrides are applied first, followed by `pinned_hits` and finally `hidden_hits`.
PinnedHits *string `json:"pinned_hits,omitempty"`
// PreSegmentedQuery You can index content from any logographic language into Typesense if you are able to segment / split the text into space-separated words yourself before indexing and querying.
// Set this parameter to true to do the same
PreSegmentedQuery *bool `json:"pre_segmented_query,omitempty"`
// Prefix Boolean field to indicate that the last word in the query should be treated as a prefix, and not as a whole word. This is used for building autocomplete and instant search interfaces. Defaults to true.
Prefix *string `json:"prefix,omitempty"`
// Preset Search using a bunch of search parameters by setting this parameter to the name of the existing Preset.
Preset *string `json:"preset,omitempty"`
// PrioritizeExactMatch Set this parameter to true to ensure that an exact match is ranked above the others
PrioritizeExactMatch *bool `json:"prioritize_exact_match,omitempty"`
// PrioritizeNumMatchingFields Make Typesense prioritize documents where the query words appear in more number of fields.
PrioritizeNumMatchingFields *bool `json:"prioritize_num_matching_fields,omitempty"`
// PrioritizeTokenPosition Make Typesense prioritize documents where the query words appear earlier in the text.
PrioritizeTokenPosition *bool `json:"prioritize_token_position,omitempty"`
// Q The query text to search for in the collection. Use * as the search string to return all documents. This is typically useful when used in conjunction with filter_by.
Q *string `json:"q,omitempty"`
// QueryBy A list of `string` fields that should be queried against. Multiple fields are separated with a comma.
QueryBy *string `json:"query_by,omitempty"`
// QueryByWeights The relative weight to give each `query_by` field when ranking results. This can be used to boost fields in priority, when looking for matches. Multiple fields are separated with a comma.
QueryByWeights *string `json:"query_by_weights,omitempty"`
// RemoteEmbeddingNumTries Number of times to retry fetching remote embeddings.
RemoteEmbeddingNumTries *int `json:"remote_embedding_num_tries,omitempty"`
// RemoteEmbeddingTimeoutMs Timeout (in milliseconds) for fetching remote embeddings.
RemoteEmbeddingTimeoutMs *int `json:"remote_embedding_timeout_ms,omitempty"`
// SearchCutoffMs Typesense will attempt to return results early if the cutoff time has elapsed. This is not a strict guarantee and facet computation is not bound by this parameter.
SearchCutoffMs *int `json:"search_cutoff_ms,omitempty"`
// SnippetThreshold Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion. Default: 30
SnippetThreshold *int `json:"snippet_threshold,omitempty"`
// SortBy A list of numerical fields and their corresponding sort orders that will be used for ordering your results. Up to 3 sort fields can be specified. The text similarity score is exposed as a special `_text_match` field that you can use in the list of sorting fields. If no `sort_by` parameter is specified, results are sorted by `_text_match:desc,default_sorting_field:desc`
SortBy *string `json:"sort_by,omitempty"`
// Stopwords Name of the stopwords set to apply for this search, the keywords present in the set will be removed from the search query.
Stopwords *string `json:"stopwords,omitempty"`
// SynonymNumTypos Allow synonym resolution on typo-corrected words in the query. Default: 0
SynonymNumTypos *int `json:"synonym_num_typos,omitempty"`
// SynonymPrefix Allow synonym resolution on word prefixes in the query. Default: false
SynonymPrefix *bool `json:"synonym_prefix,omitempty"`
// TextMatchType In a multi-field matching context, this parameter determines how the representative text match score of a record is calculated. Possible values are max_score (default) or max_weight.
TextMatchType *string `json:"text_match_type,omitempty"`
// TypoTokensThreshold If the number of results found for a specific query is less than this number, Typesense will attempt to look for tokens with more typos until enough results are found. Default: 100
TypoTokensThreshold *int `json:"typo_tokens_threshold,omitempty"`
// UseCache Enable server side caching of search query results. By default, caching is disabled.
UseCache *bool `json:"use_cache,omitempty"`
// VectorQuery Vector query expression for fetching documents "closest" to a given query/document vector.
VectorQuery *string `json:"vector_query,omitempty"`
// VoiceQuery The base64 encoded audio file in 16 khz 16-bit WAV format.
VoiceQuery *string `json:"voice_query,omitempty"`
}
MultiSearchParameters Parameters for the multi search API.
type MultiSearchParams ¶
type MultiSearchParams struct {
CacheTtl *int `form:"cache_ttl,omitempty" json:"cache_ttl,omitempty"`
Conversation *bool `form:"conversation,omitempty" json:"conversation,omitempty"`
ConversationId *string `form:"conversation_id,omitempty" json:"conversation_id,omitempty"`
ConversationModelId *string `form:"conversation_model_id,omitempty" json:"conversation_model_id,omitempty"`
DropTokensMode *DropTokensMode `form:"drop_tokens_mode,omitempty" json:"drop_tokens_mode,omitempty"`
DropTokensThreshold *int `form:"drop_tokens_threshold,omitempty" json:"drop_tokens_threshold,omitempty"`
EnableHighlightV1 *bool `form:"enable_highlight_v1,omitempty" json:"enable_highlight_v1,omitempty"`
EnableOverrides *bool `form:"enable_overrides,omitempty" json:"enable_overrides,omitempty"`
EnableSynonyms *bool `form:"enable_synonyms,omitempty" json:"enable_synonyms,omitempty"`
EnableTyposForAlphaNumericalTokens *bool `form:"enable_typos_for_alpha_numerical_tokens,omitempty" json:"enable_typos_for_alpha_numerical_tokens,omitempty"`
EnableTyposForNumericalTokens *bool `form:"enable_typos_for_numerical_tokens,omitempty" json:"enable_typos_for_numerical_tokens,omitempty"`
ExcludeFields *string `form:"exclude_fields,omitempty" json:"exclude_fields,omitempty"`
ExhaustiveSearch *bool `form:"exhaustive_search,omitempty" json:"exhaustive_search,omitempty"`
FacetBy *string `form:"facet_by,omitempty" json:"facet_by,omitempty"`
FacetQuery *string `form:"facet_query,omitempty" json:"facet_query,omitempty"`
FacetReturnParent *string `form:"facet_return_parent,omitempty" json:"facet_return_parent,omitempty"`
FacetStrategy *string `form:"facet_strategy,omitempty" json:"facet_strategy,omitempty"`
FilterBy *string `form:"filter_by,omitempty" json:"filter_by,omitempty"`
FilterCuratedHits *bool `form:"filter_curated_hits,omitempty" json:"filter_curated_hits,omitempty"`
GroupBy *string `form:"group_by,omitempty" json:"group_by,omitempty"`
GroupLimit *int `form:"group_limit,omitempty" json:"group_limit,omitempty"`
GroupMissingValues *bool `form:"group_missing_values,omitempty" json:"group_missing_values,omitempty"`
HiddenHits *string `form:"hidden_hits,omitempty" json:"hidden_hits,omitempty"`
HighlightAffixNumTokens *int `form:"highlight_affix_num_tokens,omitempty" json:"highlight_affix_num_tokens,omitempty"`
HighlightEndTag *string `form:"highlight_end_tag,omitempty" json:"highlight_end_tag,omitempty"`
HighlightFields *string `form:"highlight_fields,omitempty" json:"highlight_fields,omitempty"`
HighlightFullFields *string `form:"highlight_full_fields,omitempty" json:"highlight_full_fields,omitempty"`
HighlightStartTag *string `form:"highlight_start_tag,omitempty" json:"highlight_start_tag,omitempty"`
IncludeFields *string `form:"include_fields,omitempty" json:"include_fields,omitempty"`
Infix *string `form:"infix,omitempty" json:"infix,omitempty"`
Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
MaxCandidates *int `form:"max_candidates,omitempty" json:"max_candidates,omitempty"`
MaxExtraPrefix *int `form:"max_extra_prefix,omitempty" json:"max_extra_prefix,omitempty"`
MaxExtraSuffix *int `form:"max_extra_suffix,omitempty" json:"max_extra_suffix,omitempty"`
MaxFacetValues *int `form:"max_facet_values,omitempty" json:"max_facet_values,omitempty"`
MaxFilterByCandidates *int `form:"max_filter_by_candidates,omitempty" json:"max_filter_by_candidates,omitempty"`
MinLen1typo *int `form:"min_len_1typo,omitempty" json:"min_len_1typo,omitempty"`
MinLen2typo *int `form:"min_len_2typo,omitempty" json:"min_len_2typo,omitempty"`
NumTypos *string `form:"num_typos,omitempty" json:"num_typos,omitempty"`
Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
OverrideTags *string `form:"override_tags,omitempty" json:"override_tags,omitempty"`
Page *int `form:"page,omitempty" json:"page,omitempty"`
PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"`
PinnedHits *string `form:"pinned_hits,omitempty" json:"pinned_hits,omitempty"`
PreSegmentedQuery *bool `form:"pre_segmented_query,omitempty" json:"pre_segmented_query,omitempty"`
Prefix *string `form:"prefix,omitempty" json:"prefix,omitempty"`
Preset *string `form:"preset,omitempty" json:"preset,omitempty"`
PrioritizeExactMatch *bool `form:"prioritize_exact_match,omitempty" json:"prioritize_exact_match,omitempty"`
PrioritizeNumMatchingFields *bool `form:"prioritize_num_matching_fields,omitempty" json:"prioritize_num_matching_fields,omitempty"`
PrioritizeTokenPosition *bool `form:"prioritize_token_position,omitempty" json:"prioritize_token_position,omitempty"`
Q *string `form:"q,omitempty" json:"q,omitempty"`
QueryBy *string `form:"query_by,omitempty" json:"query_by,omitempty"`
QueryByWeights *string `form:"query_by_weights,omitempty" json:"query_by_weights,omitempty"`
RemoteEmbeddingNumTries *int `form:"remote_embedding_num_tries,omitempty" json:"remote_embedding_num_tries,omitempty"`
RemoteEmbeddingTimeoutMs *int `form:"remote_embedding_timeout_ms,omitempty" json:"remote_embedding_timeout_ms,omitempty"`
SearchCutoffMs *int `form:"search_cutoff_ms,omitempty" json:"search_cutoff_ms,omitempty"`
SnippetThreshold *int `form:"snippet_threshold,omitempty" json:"snippet_threshold,omitempty"`
SortBy *string `form:"sort_by,omitempty" json:"sort_by,omitempty"`
SplitJoinTokens *string `form:"split_join_tokens,omitempty" json:"split_join_tokens,omitempty"`
Stopwords *string `form:"stopwords,omitempty" json:"stopwords,omitempty"`
SynonymNumTypos *int `form:"synonym_num_typos,omitempty" json:"synonym_num_typos,omitempty"`
SynonymPrefix *bool `form:"synonym_prefix,omitempty" json:"synonym_prefix,omitempty"`
TextMatchType *string `form:"text_match_type,omitempty" json:"text_match_type,omitempty"`
TypoTokensThreshold *int `form:"typo_tokens_threshold,omitempty" json:"typo_tokens_threshold,omitempty"`
UseCache *bool `form:"use_cache,omitempty" json:"use_cache,omitempty"`
VectorQuery *string `form:"vector_query,omitempty" json:"vector_query,omitempty"`
VoiceQuery *string `form:"voice_query,omitempty" json:"voice_query,omitempty"`
}
MultiSearchParams defines parameters for MultiSearch.
type MultiSearchResponse ¶
type MultiSearchResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *MultiSearchResult
JSON400 *ApiResponse
}
func ParseMultiSearchResponse ¶
func ParseMultiSearchResponse(rsp *http.Response) (*MultiSearchResponse, error)
ParseMultiSearchResponse parses an HTTP response from a MultiSearchWithResponse call
func (MultiSearchResponse) Status ¶
func (r MultiSearchResponse) Status() string
Status returns HTTPResponse.Status
func (MultiSearchResponse) StatusCode ¶
func (r MultiSearchResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type MultiSearchResult ¶
type MultiSearchResult struct {
Conversation *SearchResultConversation `json:"conversation,omitempty"`
Results []MultiSearchResultItem `json:"results"`
}
MultiSearchResult defines model for MultiSearchResult.
type MultiSearchResultItem ¶
type MultiSearchResultItem struct {
// Code HTTP error code
Code *int64 `json:"code,omitempty"`
Conversation *SearchResultConversation `json:"conversation,omitempty"`
// Error Error description
Error *string `json:"error,omitempty"`
FacetCounts *[]FacetCounts `json:"facet_counts,omitempty"`
// Found The number of documents found
Found *int `json:"found,omitempty"`
FoundDocs *int `json:"found_docs,omitempty"`
GroupedHits *[]SearchGroupedHit `json:"grouped_hits,omitempty"`
// Hits The documents that matched the search query
Hits *[]SearchResultHit `json:"hits,omitempty"`
// OutOf The total number of documents in the collection
OutOf *int `json:"out_of,omitempty"`
// Page The search result page number
Page *int `json:"page,omitempty"`
RequestParams *struct {
CollectionName string `json:"collection_name"`
PerPage int `json:"per_page"`
Q string `json:"q"`
VoiceQuery *struct {
TranscribedQuery *string `json:"transcribed_query,omitempty"`
} `json:"voice_query,omitempty"`
} `json:"request_params,omitempty"`
// SearchCutoff Whether the search was cut off
SearchCutoff *bool `json:"search_cutoff,omitempty"`
// SearchTimeMs The number of milliseconds the search took
SearchTimeMs *int `json:"search_time_ms,omitempty"`
}
MultiSearchResultItem defines model for MultiSearchResultItem.
type MultiSearchSearchesParameter ¶
type MultiSearchSearchesParameter struct {
Searches []MultiSearchCollectionParameters `json:"searches"`
// Union When true, merges the search results from each search query into a single ordered set of hits.
Union *bool `json:"union,omitempty"`
}
MultiSearchSearchesParameter defines model for MultiSearchSearchesParameter.
type PresetDeleteSchema ¶
type PresetDeleteSchema struct {
Name string `json:"name"`
}
PresetDeleteSchema defines model for PresetDeleteSchema.
type PresetSchema ¶
type PresetSchema struct {
Name string `json:"name"`
Value PresetSchema_Value `json:"value"`
}
PresetSchema defines model for PresetSchema.
type PresetSchema_Value ¶
type PresetSchema_Value struct {
// contains filtered or unexported fields
}
PresetSchema_Value defines model for PresetSchema.Value.
func (PresetSchema_Value) AsMultiSearchSearchesParameter ¶
func (t PresetSchema_Value) AsMultiSearchSearchesParameter() (MultiSearchSearchesParameter, error)
AsMultiSearchSearchesParameter returns the union data inside the PresetSchema_Value as a MultiSearchSearchesParameter
func (PresetSchema_Value) AsSearchParameters ¶
func (t PresetSchema_Value) AsSearchParameters() (SearchParameters, error)
AsSearchParameters returns the union data inside the PresetSchema_Value as a SearchParameters
func (*PresetSchema_Value) FromMultiSearchSearchesParameter ¶
func (t *PresetSchema_Value) FromMultiSearchSearchesParameter(v MultiSearchSearchesParameter) error
FromMultiSearchSearchesParameter overwrites any union data inside the PresetSchema_Value as the provided MultiSearchSearchesParameter
func (*PresetSchema_Value) FromSearchParameters ¶
func (t *PresetSchema_Value) FromSearchParameters(v SearchParameters) error
FromSearchParameters overwrites any union data inside the PresetSchema_Value as the provided SearchParameters
func (PresetSchema_Value) MarshalJSON ¶
func (t PresetSchema_Value) MarshalJSON() ([]byte, error)
func (*PresetSchema_Value) MergeMultiSearchSearchesParameter ¶
func (t *PresetSchema_Value) MergeMultiSearchSearchesParameter(v MultiSearchSearchesParameter) error
MergeMultiSearchSearchesParameter performs a merge with any union data inside the PresetSchema_Value, using the provided MultiSearchSearchesParameter
func (*PresetSchema_Value) MergeSearchParameters ¶
func (t *PresetSchema_Value) MergeSearchParameters(v SearchParameters) error
MergeSearchParameters performs a merge with any union data inside the PresetSchema_Value, using the provided SearchParameters
func (*PresetSchema_Value) UnmarshalJSON ¶
func (t *PresetSchema_Value) UnmarshalJSON(b []byte) error
type PresetUpsertSchema ¶
type PresetUpsertSchema struct {
Value PresetUpsertSchema_Value `json:"value"`
}
PresetUpsertSchema defines model for PresetUpsertSchema.
type PresetUpsertSchema_Value ¶
type PresetUpsertSchema_Value struct {
// contains filtered or unexported fields
}
PresetUpsertSchema_Value defines model for PresetUpsertSchema.Value.
func (PresetUpsertSchema_Value) AsMultiSearchSearchesParameter ¶
func (t PresetUpsertSchema_Value) AsMultiSearchSearchesParameter() (MultiSearchSearchesParameter, error)
AsMultiSearchSearchesParameter returns the union data inside the PresetUpsertSchema_Value as a MultiSearchSearchesParameter
func (PresetUpsertSchema_Value) AsSearchParameters ¶
func (t PresetUpsertSchema_Value) AsSearchParameters() (SearchParameters, error)
AsSearchParameters returns the union data inside the PresetUpsertSchema_Value as a SearchParameters
func (*PresetUpsertSchema_Value) FromMultiSearchSearchesParameter ¶
func (t *PresetUpsertSchema_Value) FromMultiSearchSearchesParameter(v MultiSearchSearchesParameter) error
FromMultiSearchSearchesParameter overwrites any union data inside the PresetUpsertSchema_Value as the provided MultiSearchSearchesParameter
func (*PresetUpsertSchema_Value) FromSearchParameters ¶
func (t *PresetUpsertSchema_Value) FromSearchParameters(v SearchParameters) error
FromSearchParameters overwrites any union data inside the PresetUpsertSchema_Value as the provided SearchParameters
func (PresetUpsertSchema_Value) MarshalJSON ¶
func (t PresetUpsertSchema_Value) MarshalJSON() ([]byte, error)
func (*PresetUpsertSchema_Value) MergeMultiSearchSearchesParameter ¶
func (t *PresetUpsertSchema_Value) MergeMultiSearchSearchesParameter(v MultiSearchSearchesParameter) error
MergeMultiSearchSearchesParameter performs a merge with any union data inside the PresetUpsertSchema_Value, using the provided MultiSearchSearchesParameter
func (*PresetUpsertSchema_Value) MergeSearchParameters ¶
func (t *PresetUpsertSchema_Value) MergeSearchParameters(v SearchParameters) error
MergeSearchParameters performs a merge with any union data inside the PresetUpsertSchema_Value, using the provided SearchParameters
func (*PresetUpsertSchema_Value) UnmarshalJSON ¶
func (t *PresetUpsertSchema_Value) UnmarshalJSON(b []byte) error
type PresetsRetrieveSchema ¶
type PresetsRetrieveSchema struct {
Presets []*PresetSchema `json:"presets"`
}
PresetsRetrieveSchema defines model for PresetsRetrieveSchema.
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type RetrieveAPIStatsResponse ¶
type RetrieveAPIStatsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *APIStatsResponse
}
func ParseRetrieveAPIStatsResponse ¶
func ParseRetrieveAPIStatsResponse(rsp *http.Response) (*RetrieveAPIStatsResponse, error)
ParseRetrieveAPIStatsResponse parses an HTTP response from a RetrieveAPIStatsWithResponse call
func (RetrieveAPIStatsResponse) Status ¶
func (r RetrieveAPIStatsResponse) Status() string
Status returns HTTPResponse.Status
func (RetrieveAPIStatsResponse) StatusCode ¶
func (r RetrieveAPIStatsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RetrieveAllConversationModelsResponse ¶
type RetrieveAllConversationModelsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]*ConversationModelSchema
}
func ParseRetrieveAllConversationModelsResponse ¶
func ParseRetrieveAllConversationModelsResponse(rsp *http.Response) (*RetrieveAllConversationModelsResponse, error)
ParseRetrieveAllConversationModelsResponse parses an HTTP response from a RetrieveAllConversationModelsWithResponse call
func (RetrieveAllConversationModelsResponse) Status ¶
func (r RetrieveAllConversationModelsResponse) Status() string
Status returns HTTPResponse.Status
func (RetrieveAllConversationModelsResponse) StatusCode ¶
func (r RetrieveAllConversationModelsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RetrieveAllPresetsResponse ¶
type RetrieveAllPresetsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *PresetsRetrieveSchema
}
func ParseRetrieveAllPresetsResponse ¶
func ParseRetrieveAllPresetsResponse(rsp *http.Response) (*RetrieveAllPresetsResponse, error)
ParseRetrieveAllPresetsResponse parses an HTTP response from a RetrieveAllPresetsWithResponse call
func (RetrieveAllPresetsResponse) Status ¶
func (r RetrieveAllPresetsResponse) Status() string
Status returns HTTPResponse.Status
func (RetrieveAllPresetsResponse) StatusCode ¶
func (r RetrieveAllPresetsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RetrieveAnalyticsRuleResponse ¶
type RetrieveAnalyticsRuleResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AnalyticsRuleSchema
JSON404 *ApiResponse
}
func ParseRetrieveAnalyticsRuleResponse ¶
func ParseRetrieveAnalyticsRuleResponse(rsp *http.Response) (*RetrieveAnalyticsRuleResponse, error)
ParseRetrieveAnalyticsRuleResponse parses an HTTP response from a RetrieveAnalyticsRuleWithResponse call
func (RetrieveAnalyticsRuleResponse) Status ¶
func (r RetrieveAnalyticsRuleResponse) Status() string
Status returns HTTPResponse.Status
func (RetrieveAnalyticsRuleResponse) StatusCode ¶
func (r RetrieveAnalyticsRuleResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RetrieveAnalyticsRulesResponse ¶
type RetrieveAnalyticsRulesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AnalyticsRulesRetrieveSchema
}
func ParseRetrieveAnalyticsRulesResponse ¶
func ParseRetrieveAnalyticsRulesResponse(rsp *http.Response) (*RetrieveAnalyticsRulesResponse, error)
ParseRetrieveAnalyticsRulesResponse parses an HTTP response from a RetrieveAnalyticsRulesWithResponse call
func (RetrieveAnalyticsRulesResponse) Status ¶
func (r RetrieveAnalyticsRulesResponse) Status() string
Status returns HTTPResponse.Status
func (RetrieveAnalyticsRulesResponse) StatusCode ¶
func (r RetrieveAnalyticsRulesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RetrieveConversationModelResponse ¶
type RetrieveConversationModelResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ConversationModelSchema
}
func ParseRetrieveConversationModelResponse ¶
func ParseRetrieveConversationModelResponse(rsp *http.Response) (*RetrieveConversationModelResponse, error)
ParseRetrieveConversationModelResponse parses an HTTP response from a RetrieveConversationModelWithResponse call
func (RetrieveConversationModelResponse) Status ¶
func (r RetrieveConversationModelResponse) Status() string
Status returns HTTPResponse.Status
func (RetrieveConversationModelResponse) StatusCode ¶
func (r RetrieveConversationModelResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RetrieveMetricsResponse ¶
type RetrieveMetricsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *map[string]interface{}
}
func ParseRetrieveMetricsResponse ¶
func ParseRetrieveMetricsResponse(rsp *http.Response) (*RetrieveMetricsResponse, error)
ParseRetrieveMetricsResponse parses an HTTP response from a RetrieveMetricsWithResponse call
func (RetrieveMetricsResponse) Status ¶
func (r RetrieveMetricsResponse) Status() string
Status returns HTTPResponse.Status
func (RetrieveMetricsResponse) StatusCode ¶
func (r RetrieveMetricsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RetrievePresetResponse ¶
type RetrievePresetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *PresetSchema
JSON404 *ApiResponse
}
func ParseRetrievePresetResponse ¶
func ParseRetrievePresetResponse(rsp *http.Response) (*RetrievePresetResponse, error)
ParseRetrievePresetResponse parses an HTTP response from a RetrievePresetWithResponse call
func (RetrievePresetResponse) Status ¶
func (r RetrievePresetResponse) Status() string
Status returns HTTPResponse.Status
func (RetrievePresetResponse) StatusCode ¶
func (r RetrievePresetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RetrieveStopwordsSetResponse ¶
type RetrieveStopwordsSetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *StopwordsSetRetrieveSchema
JSON404 *ApiResponse
}
func ParseRetrieveStopwordsSetResponse ¶
func ParseRetrieveStopwordsSetResponse(rsp *http.Response) (*RetrieveStopwordsSetResponse, error)
ParseRetrieveStopwordsSetResponse parses an HTTP response from a RetrieveStopwordsSetWithResponse call
func (RetrieveStopwordsSetResponse) Status ¶
func (r RetrieveStopwordsSetResponse) Status() string
Status returns HTTPResponse.Status
func (RetrieveStopwordsSetResponse) StatusCode ¶
func (r RetrieveStopwordsSetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RetrieveStopwordsSetsResponse ¶
type RetrieveStopwordsSetsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *StopwordsSetsRetrieveAllSchema
}
func ParseRetrieveStopwordsSetsResponse ¶
func ParseRetrieveStopwordsSetsResponse(rsp *http.Response) (*RetrieveStopwordsSetsResponse, error)
ParseRetrieveStopwordsSetsResponse parses an HTTP response from a RetrieveStopwordsSetsWithResponse call
func (RetrieveStopwordsSetsResponse) Status ¶
func (r RetrieveStopwordsSetsResponse) Status() string
Status returns HTTPResponse.Status
func (RetrieveStopwordsSetsResponse) StatusCode ¶
func (r RetrieveStopwordsSetsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SchemaChangeStatus ¶
type SchemaChangeStatus struct {
// AlteredDocs Number of documents that have been altered
AlteredDocs *int `json:"altered_docs,omitempty"`
// Collection Name of the collection being modified
Collection *string `json:"collection,omitempty"`
// ValidatedDocs Number of documents that have been validated
ValidatedDocs *int `json:"validated_docs,omitempty"`
}
SchemaChangeStatus defines model for SchemaChangeStatus.
type SearchCollectionParams ¶
type SearchCollectionParams struct {
CacheTtl *int `form:"cache_ttl,omitempty" json:"cache_ttl,omitempty"`
Conversation *bool `form:"conversation,omitempty" json:"conversation,omitempty"`
ConversationId *string `form:"conversation_id,omitempty" json:"conversation_id,omitempty"`
ConversationModelId *string `form:"conversation_model_id,omitempty" json:"conversation_model_id,omitempty"`
DropTokensMode *DropTokensMode `form:"drop_tokens_mode,omitempty" json:"drop_tokens_mode,omitempty"`
DropTokensThreshold *int `form:"drop_tokens_threshold,omitempty" json:"drop_tokens_threshold,omitempty"`
EnableHighlightV1 *bool `form:"enable_highlight_v1,omitempty" json:"enable_highlight_v1,omitempty"`
EnableOverrides *bool `form:"enable_overrides,omitempty" json:"enable_overrides,omitempty"`
EnableSynonyms *bool `form:"enable_synonyms,omitempty" json:"enable_synonyms,omitempty"`
EnableTyposForAlphaNumericalTokens *bool `form:"enable_typos_for_alpha_numerical_tokens,omitempty" json:"enable_typos_for_alpha_numerical_tokens,omitempty"`
EnableTyposForNumericalTokens *bool `form:"enable_typos_for_numerical_tokens,omitempty" json:"enable_typos_for_numerical_tokens,omitempty"`
ExcludeFields *string `form:"exclude_fields,omitempty" json:"exclude_fields,omitempty"`
ExhaustiveSearch *bool `form:"exhaustive_search,omitempty" json:"exhaustive_search,omitempty"`
FacetBy *string `form:"facet_by,omitempty" json:"facet_by,omitempty"`
FacetQuery *string `form:"facet_query,omitempty" json:"facet_query,omitempty"`
FacetReturnParent *string `form:"facet_return_parent,omitempty" json:"facet_return_parent,omitempty"`
FacetStrategy *string `form:"facet_strategy,omitempty" json:"facet_strategy,omitempty"`
FilterBy *string `form:"filter_by,omitempty" json:"filter_by,omitempty"`
FilterCuratedHits *bool `form:"filter_curated_hits,omitempty" json:"filter_curated_hits,omitempty"`
GroupBy *string `form:"group_by,omitempty" json:"group_by,omitempty"`
GroupLimit *int `form:"group_limit,omitempty" json:"group_limit,omitempty"`
GroupMissingValues *bool `form:"group_missing_values,omitempty" json:"group_missing_values,omitempty"`
HiddenHits *string `form:"hidden_hits,omitempty" json:"hidden_hits,omitempty"`
HighlightAffixNumTokens *int `form:"highlight_affix_num_tokens,omitempty" json:"highlight_affix_num_tokens,omitempty"`
HighlightEndTag *string `form:"highlight_end_tag,omitempty" json:"highlight_end_tag,omitempty"`
HighlightFields *string `form:"highlight_fields,omitempty" json:"highlight_fields,omitempty"`
HighlightFullFields *string `form:"highlight_full_fields,omitempty" json:"highlight_full_fields,omitempty"`
HighlightStartTag *string `form:"highlight_start_tag,omitempty" json:"highlight_start_tag,omitempty"`
IncludeFields *string `form:"include_fields,omitempty" json:"include_fields,omitempty"`
Infix *string `form:"infix,omitempty" json:"infix,omitempty"`
Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
MaxCandidates *int `form:"max_candidates,omitempty" json:"max_candidates,omitempty"`
MaxExtraPrefix *int `form:"max_extra_prefix,omitempty" json:"max_extra_prefix,omitempty"`
MaxExtraSuffix *int `form:"max_extra_suffix,omitempty" json:"max_extra_suffix,omitempty"`
MaxFacetValues *int `form:"max_facet_values,omitempty" json:"max_facet_values,omitempty"`
MaxFilterByCandidates *int `form:"max_filter_by_candidates,omitempty" json:"max_filter_by_candidates,omitempty"`
MinLen1typo *int `form:"min_len_1typo,omitempty" json:"min_len_1typo,omitempty"`
MinLen2typo *int `form:"min_len_2typo,omitempty" json:"min_len_2typo,omitempty"`
NumTypos *string `form:"num_typos,omitempty" json:"num_typos,omitempty"`
Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
OverrideTags *string `form:"override_tags,omitempty" json:"override_tags,omitempty"`
Page *int `form:"page,omitempty" json:"page,omitempty"`
PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"`
PinnedHits *string `form:"pinned_hits,omitempty" json:"pinned_hits,omitempty"`
PreSegmentedQuery *bool `form:"pre_segmented_query,omitempty" json:"pre_segmented_query,omitempty"`
Prefix *string `form:"prefix,omitempty" json:"prefix,omitempty"`
Preset *string `form:"preset,omitempty" json:"preset,omitempty"`
PrioritizeExactMatch *bool `form:"prioritize_exact_match,omitempty" json:"prioritize_exact_match,omitempty"`
PrioritizeNumMatchingFields *bool `form:"prioritize_num_matching_fields,omitempty" json:"prioritize_num_matching_fields,omitempty"`
PrioritizeTokenPosition *bool `form:"prioritize_token_position,omitempty" json:"prioritize_token_position,omitempty"`
Q *string `form:"q,omitempty" json:"q,omitempty"`
QueryBy *string `form:"query_by,omitempty" json:"query_by,omitempty"`
QueryByWeights *string `form:"query_by_weights,omitempty" json:"query_by_weights,omitempty"`
RemoteEmbeddingNumTries *int `form:"remote_embedding_num_tries,omitempty" json:"remote_embedding_num_tries,omitempty"`
RemoteEmbeddingTimeoutMs *int `form:"remote_embedding_timeout_ms,omitempty" json:"remote_embedding_timeout_ms,omitempty"`
SearchCutoffMs *int `form:"search_cutoff_ms,omitempty" json:"search_cutoff_ms,omitempty"`
SnippetThreshold *int `form:"snippet_threshold,omitempty" json:"snippet_threshold,omitempty"`
SortBy *string `form:"sort_by,omitempty" json:"sort_by,omitempty"`
SplitJoinTokens *string `form:"split_join_tokens,omitempty" json:"split_join_tokens,omitempty"`
Stopwords *string `form:"stopwords,omitempty" json:"stopwords,omitempty"`
SynonymNumTypos *int `form:"synonym_num_typos,omitempty" json:"synonym_num_typos,omitempty"`
SynonymPrefix *bool `form:"synonym_prefix,omitempty" json:"synonym_prefix,omitempty"`
TextMatchType *string `form:"text_match_type,omitempty" json:"text_match_type,omitempty"`
TypoTokensThreshold *int `form:"typo_tokens_threshold,omitempty" json:"typo_tokens_threshold,omitempty"`
UseCache *bool `form:"use_cache,omitempty" json:"use_cache,omitempty"`
VectorQuery *string `form:"vector_query,omitempty" json:"vector_query,omitempty"`
VoiceQuery *string `form:"voice_query,omitempty" json:"voice_query,omitempty"`
}
SearchCollectionParams defines parameters for SearchCollection.
type SearchCollectionResponse ¶
type SearchCollectionResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SearchResult
JSON400 *ApiResponse
JSON404 *ApiResponse
}
func ParseSearchCollectionResponse ¶
func ParseSearchCollectionResponse(rsp *http.Response) (*SearchCollectionResponse, error)
ParseSearchCollectionResponse parses an HTTP response from a SearchCollectionWithResponse call
func (SearchCollectionResponse) Status ¶
func (r SearchCollectionResponse) Status() string
Status returns HTTPResponse.Status
func (SearchCollectionResponse) StatusCode ¶
func (r SearchCollectionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SearchGroupedHit ¶
type SearchGroupedHit struct {
Found *int `json:"found,omitempty"`
GroupKey []interface{} `json:"group_key"`
// Hits The documents that matched the search query
Hits []SearchResultHit `json:"hits"`
}
SearchGroupedHit defines model for SearchGroupedHit.
type SearchHighlight ¶
type SearchHighlight struct {
Field *string `json:"field,omitempty"`
// Indices The indices property will be present only for string[] fields and will contain the corresponding indices of the snippets in the search field
Indices *[]int `json:"indices,omitempty"`
MatchedTokens *[]interface{} `json:"matched_tokens,omitempty"`
// Snippet Present only for (non-array) string fields
Snippet *string `json:"snippet,omitempty"`
// Snippets Present only for (array) string[] fields
Snippets *[]string `json:"snippets,omitempty"`
// Value Full field value with highlighting, present only for (non-array) string fields
Value *string `json:"value,omitempty"`
// Values Full field value with highlighting, present only for (array) string[] fields
Values *[]string `json:"values,omitempty"`
}
SearchHighlight defines model for SearchHighlight.
type SearchOverride ¶
type SearchOverride struct {
// EffectiveFromTs A Unix timestamp that indicates the date/time from which the override will be active. You can use this to create override rules that start applying from a future point in time.
EffectiveFromTs *int `json:"effective_from_ts,omitempty"`
// EffectiveToTs A Unix timestamp that indicates the date/time until which the override will be active. You can use this to create override rules that stop applying after a period of time.
EffectiveToTs *int `json:"effective_to_ts,omitempty"`
// Excludes List of document `id`s that should be excluded from the search results.
Excludes *[]SearchOverrideExclude `json:"excludes,omitempty"`
// FilterBy A filter by clause that is applied to any search query that matches the override rule.
FilterBy *string `json:"filter_by,omitempty"`
// FilterCuratedHits When set to true, the filter conditions of the query is applied to the curated records as well. Default: false.
FilterCuratedHits *bool `json:"filter_curated_hits,omitempty"`
Id *string `json:"id,omitempty"`
// Includes List of document `id`s that should be included in the search results with their corresponding `position`s.
Includes *[]SearchOverrideInclude `json:"includes,omitempty"`
// Metadata Return a custom JSON object in the Search API response, when this rule is triggered. This can can be used to display a pre-defined message (eg: a promotion banner) on the front-end when a particular rule is triggered.
Metadata *map[string]interface{} `json:"metadata,omitempty"`
// RemoveMatchedTokens Indicates whether search query tokens that exist in the override's rule should be removed from the search query.
RemoveMatchedTokens *bool `json:"remove_matched_tokens,omitempty"`
// ReplaceQuery Replaces the current search query with this value, when the search query matches the override rule.
ReplaceQuery *string `json:"replace_query,omitempty"`
Rule SearchOverrideRule `json:"rule"`
// SortBy A sort by clause that is applied to any search query that matches the override rule.
SortBy *string `json:"sort_by,omitempty"`
// StopProcessing When set to true, override processing will stop at the first matching rule. When set to false override processing will continue and multiple override actions will be triggered in sequence. Overrides are processed in the lexical sort order of their id field. Default: true.
StopProcessing *bool `json:"stop_processing,omitempty"`
}
SearchOverride defines model for SearchOverride.
type SearchOverrideDeleteResponse ¶
type SearchOverrideDeleteResponse struct {
// Id The id of the override that was deleted
Id string `json:"id"`
}
SearchOverrideDeleteResponse defines model for SearchOverrideDeleteResponse.
type SearchOverrideExclude ¶
type SearchOverrideExclude struct {
// Id document id that should be excluded from the search results.
Id string `json:"id"`
}
SearchOverrideExclude defines model for SearchOverrideExclude.
type SearchOverrideInclude ¶
type SearchOverrideInclude struct {
// Id document id that should be included
Id string `json:"id"`
// Position position number where document should be included in the search results
Position int `json:"position"`
}
SearchOverrideInclude defines model for SearchOverrideInclude.
type SearchOverrideRule ¶
type SearchOverrideRule struct {
// FilterBy Indicates that the override should apply when the filter_by parameter in a search query exactly matches the string specified here (including backticks, spaces, brackets, etc).
FilterBy *string `json:"filter_by,omitempty"`
// Match Indicates whether the match on the query term should be `exact` or `contains`. If we want to match all queries that contained the word `apple`, we will use the `contains` match instead.
Match *SearchOverrideRuleMatch `json:"match,omitempty"`
// Query Indicates what search queries should be overridden
Query *string `json:"query,omitempty"`
// Tags List of tag values to associate with this override rule.
Tags *[]string `json:"tags,omitempty"`
}
SearchOverrideRule defines model for SearchOverrideRule.
type SearchOverrideRuleMatch ¶
type SearchOverrideRuleMatch string
SearchOverrideRuleMatch Indicates whether the match on the query term should be `exact` or `contains`. If we want to match all queries that contained the word `apple`, we will use the `contains` match instead.
const ( Contains SearchOverrideRuleMatch = "contains" Exact SearchOverrideRuleMatch = "exact" )
Defines values for SearchOverrideRuleMatch.
type SearchOverrideSchema ¶
type SearchOverrideSchema struct {
// EffectiveFromTs A Unix timestamp that indicates the date/time from which the override will be active. You can use this to create override rules that start applying from a future point in time.
EffectiveFromTs *int `json:"effective_from_ts,omitempty"`
// EffectiveToTs A Unix timestamp that indicates the date/time until which the override will be active. You can use this to create override rules that stop applying after a period of time.
EffectiveToTs *int `json:"effective_to_ts,omitempty"`
// Excludes List of document `id`s that should be excluded from the search results.
Excludes *[]SearchOverrideExclude `json:"excludes,omitempty"`
// FilterBy A filter by clause that is applied to any search query that matches the override rule.
FilterBy *string `json:"filter_by,omitempty"`
// FilterCuratedHits When set to true, the filter conditions of the query is applied to the curated records as well. Default: false.
FilterCuratedHits *bool `json:"filter_curated_hits,omitempty"`
// Includes List of document `id`s that should be included in the search results with their corresponding `position`s.
Includes *[]SearchOverrideInclude `json:"includes,omitempty"`
// Metadata Return a custom JSON object in the Search API response, when this rule is triggered. This can can be used to display a pre-defined message (eg: a promotion banner) on the front-end when a particular rule is triggered.
Metadata *map[string]interface{} `json:"metadata,omitempty"`
// RemoveMatchedTokens Indicates whether search query tokens that exist in the override's rule should be removed from the search query.
RemoveMatchedTokens *bool `json:"remove_matched_tokens,omitempty"`
// ReplaceQuery Replaces the current search query with this value, when the search query matches the override rule.
ReplaceQuery *string `json:"replace_query,omitempty"`
Rule SearchOverrideRule `json:"rule"`
// SortBy A sort by clause that is applied to any search query that matches the override rule.
SortBy *string `json:"sort_by,omitempty"`
// StopProcessing When set to true, override processing will stop at the first matching rule. When set to false override processing will continue and multiple override actions will be triggered in sequence. Overrides are processed in the lexical sort order of their id field. Default: true.
StopProcessing *bool `json:"stop_processing,omitempty"`
}
SearchOverrideSchema defines model for SearchOverrideSchema.
type SearchOverridesResponse ¶
type SearchOverridesResponse struct {
Overrides []*SearchOverride `json:"overrides"`
}
SearchOverridesResponse defines model for SearchOverridesResponse.
type SearchParameters ¶
type SearchParameters struct {
// CacheTtl The duration (in seconds) that determines how long the search query is cached. This value can be set on a per-query basis. Default: 60.
CacheTtl *int `json:"cache_ttl,omitempty"`
// Conversation Enable conversational search.
Conversation *bool `json:"conversation,omitempty"`
// ConversationId The Id of a previous conversation to continue, this tells Typesense to include prior context when communicating with the LLM.
ConversationId *string `json:"conversation_id,omitempty"`
// ConversationModelId The Id of Conversation Model to be used.
ConversationModelId *string `json:"conversation_model_id,omitempty"`
// DropTokensMode Dictates the direction in which the words in the query must be dropped when the original words in the query do not appear in any document. Values: right_to_left (default), left_to_right, both_sides:3 A note on both_sides:3 - for queries upto 3 tokens (words) in length, this mode will drop tokens from both sides and exhaustively rank all matching results. If query length is greater than 3 words, Typesense will just fallback to default behavior of right_to_left
DropTokensMode *DropTokensMode `json:"drop_tokens_mode,omitempty"`
// DropTokensThreshold If the number of results found for a specific query is less than this number, Typesense will attempt to drop the tokens in the query until enough results are found. Tokens that have the least individual hits are dropped first. Set to 0 to disable. Default: 10
DropTokensThreshold *int `json:"drop_tokens_threshold,omitempty"`
// EnableHighlightV1 Flag for enabling/disabling the deprecated, old highlight structure in the response. Default: true
EnableHighlightV1 *bool `json:"enable_highlight_v1,omitempty"`
// EnableOverrides If you have some overrides defined but want to disable all of them during query time, you can do that by setting this parameter to false
EnableOverrides *bool `json:"enable_overrides,omitempty"`
// EnableSynonyms If you have some synonyms defined but want to disable all of them for a particular search query, set enable_synonyms to false. Default: true
EnableSynonyms *bool `json:"enable_synonyms,omitempty"`
// EnableTyposForAlphaNumericalTokens Set this parameter to false to disable typos on alphanumerical query tokens. Default: true.
EnableTyposForAlphaNumericalTokens *bool `json:"enable_typos_for_alpha_numerical_tokens,omitempty"`
// EnableTyposForNumericalTokens Make Typesense disable typos for numerical tokens.
EnableTyposForNumericalTokens *bool `json:"enable_typos_for_numerical_tokens,omitempty"`
// ExcludeFields List of fields from the document to exclude in the search result
ExcludeFields *string `json:"exclude_fields,omitempty"`
// ExhaustiveSearch Setting this to true will make Typesense consider all prefixes and typo corrections of the words in the query without stopping early when enough results are found (drop_tokens_threshold and typo_tokens_threshold configurations are ignored).
ExhaustiveSearch *bool `json:"exhaustive_search,omitempty"`
// FacetBy A list of fields that will be used for faceting your results on. Separate multiple fields with a comma.
FacetBy *string `json:"facet_by,omitempty"`
// FacetQuery Facet values that are returned can now be filtered via this parameter. The matching facet text is also highlighted. For example, when faceting by `category`, you can set `facet_query=category:shoe` to return only facet values that contain the prefix "shoe".
FacetQuery *string `json:"facet_query,omitempty"`
// FacetReturnParent Comma separated string of nested facet fields whose parent object should be returned in facet response.
FacetReturnParent *string `json:"facet_return_parent,omitempty"`
// FacetStrategy Choose the underlying faceting strategy used. Comma separated string of allows values: exhaustive, top_values or automatic (default).
FacetStrategy *string `json:"facet_strategy,omitempty"`
// FilterBy Filter conditions for refining youropen api validator search results. Separate multiple conditions with &&.
FilterBy *string `json:"filter_by,omitempty"`
// FilterCuratedHits Whether the filter_by condition of the search query should be applicable to curated results (override definitions, pinned hits, hidden hits, etc.). Default: false
FilterCuratedHits *bool `json:"filter_curated_hits,omitempty"`
// GroupBy You can aggregate search results into groups or buckets by specify one or more `group_by` fields. Separate multiple fields with a comma. To group on a particular field, it must be a faceted field.
GroupBy *string `json:"group_by,omitempty"`
// GroupLimit Maximum number of hits to be returned for every group. If the `group_limit` is set as `K` then only the top K hits in each group are returned in the response. Default: 3
GroupLimit *int `json:"group_limit,omitempty"`
// GroupMissingValues Setting this parameter to true will place all documents that have a null value in the group_by field, into a single group. Setting this parameter to false, will cause each document with a null value in the group_by field to not be grouped with other documents. Default: true
GroupMissingValues *bool `json:"group_missing_values,omitempty"`
// HiddenHits A list of records to unconditionally hide from search results. A list of `record_id`s to hide. Eg: to hide records with IDs 123 and 456, you'd specify `123,456`.
// You could also use the Overrides feature to override search results based on rules. Overrides are applied first, followed by `pinned_hits` and finally `hidden_hits`.
HiddenHits *string `json:"hidden_hits,omitempty"`
// HighlightAffixNumTokens The number of tokens that should surround the highlighted text on each side. Default: 4
HighlightAffixNumTokens *int `json:"highlight_affix_num_tokens,omitempty"`
// HighlightEndTag The end tag used for the highlighted snippets. Default: `</mark>`
HighlightEndTag *string `json:"highlight_end_tag,omitempty"`
// HighlightFields A list of custom fields that must be highlighted even if you don't query for them
HighlightFields *string `json:"highlight_fields,omitempty"`
// HighlightFullFields List of fields which should be highlighted fully without snippeting
HighlightFullFields *string `json:"highlight_full_fields,omitempty"`
// HighlightStartTag The start tag used for the highlighted snippets. Default: `<mark>`
HighlightStartTag *string `json:"highlight_start_tag,omitempty"`
// IncludeFields List of fields from the document to include in the search result
IncludeFields *string `json:"include_fields,omitempty"`
// Infix If infix index is enabled for this field, infix searching can be done on a per-field basis by sending a comma separated string parameter called infix to the search query. This parameter can have 3 values; `off` infix search is disabled, which is default `always` infix search is performed along with regular search `fallback` infix search is performed if regular search does not produce results
Infix *string `json:"infix,omitempty"`
// Limit Number of hits to fetch. Can be used as an alternative to the per_page parameter. Default: 10.
Limit *int `json:"limit,omitempty"`
// MaxCandidates Control the number of words that Typesense considers for typo and prefix searching.
MaxCandidates *int `json:"max_candidates,omitempty"`
// MaxExtraPrefix There are also 2 parameters that allow you to control the extent of infix searching max_extra_prefix and max_extra_suffix which specify the maximum number of symbols before or after the query that can be present in the token. For example query "K2100" has 2 extra symbols in "6PK2100". By default, any number of prefixes/suffixes can be present for a match.
MaxExtraPrefix *int `json:"max_extra_prefix,omitempty"`
// MaxExtraSuffix There are also 2 parameters that allow you to control the extent of infix searching max_extra_prefix and max_extra_suffix which specify the maximum number of symbols before or after the query that can be present in the token. For example query "K2100" has 2 extra symbols in "6PK2100". By default, any number of prefixes/suffixes can be present for a match.
MaxExtraSuffix *int `json:"max_extra_suffix,omitempty"`
// MaxFacetValues Maximum number of facet values to be returned.
MaxFacetValues *int `json:"max_facet_values,omitempty"`
// MaxFilterByCandidates Controls the number of similar words that Typesense considers during fuzzy search on filter_by values. Useful for controlling prefix matches like company_name:Acm*.
MaxFilterByCandidates *int `json:"max_filter_by_candidates,omitempty"`
// MinLen1typo Minimum word length for 1-typo correction to be applied. The value of num_typos is still treated as the maximum allowed typos.
MinLen1typo *int `json:"min_len_1typo,omitempty"`
// MinLen2typo Minimum word length for 2-typo correction to be applied. The value of num_typos is still treated as the maximum allowed typos.
MinLen2typo *int `json:"min_len_2typo,omitempty"`
// NumTypos The number of typographical errors (1 or 2) that would be tolerated. Default: 2
NumTypos *string `json:"num_typos,omitempty"`
// Offset Identifies the starting point to return hits from a result set. Can be used as an alternative to the page parameter.
Offset *int `json:"offset,omitempty"`
// OverrideTags Comma separated list of tags to trigger the curations rules that match the tags.
OverrideTags *string `json:"override_tags,omitempty"`
// Page Results from this specific page number would be fetched.
Page *int `json:"page,omitempty"`
// PerPage Number of results to fetch per page. Default: 10
PerPage *int `json:"per_page,omitempty"`
// PinnedHits A list of records to unconditionally include in the search results at specific positions. An example use case would be to feature or promote certain items on the top of search results. A list of `record_id:hit_position`. Eg: to include a record with ID 123 at Position 1 and another record with ID 456 at Position 5, you'd specify `123:1,456:5`.
// You could also use the Overrides feature to override search results based on rules. Overrides are applied first, followed by `pinned_hits` and finally `hidden_hits`.
PinnedHits *string `json:"pinned_hits,omitempty"`
// PreSegmentedQuery You can index content from any logographic language into Typesense if you are able to segment / split the text into space-separated words yourself before indexing and querying.
// Set this parameter to true to do the same
PreSegmentedQuery *bool `json:"pre_segmented_query,omitempty"`
// Prefix Boolean field to indicate that the last word in the query should be treated as a prefix, and not as a whole word. This is used for building autocomplete and instant search interfaces. Defaults to true.
Prefix *string `json:"prefix,omitempty"`
// Preset Search using a bunch of search parameters by setting this parameter to the name of the existing Preset.
Preset *string `json:"preset,omitempty"`
// PrioritizeExactMatch Set this parameter to true to ensure that an exact match is ranked above the others
PrioritizeExactMatch *bool `json:"prioritize_exact_match,omitempty"`
// PrioritizeNumMatchingFields Make Typesense prioritize documents where the query words appear in more number of fields.
PrioritizeNumMatchingFields *bool `json:"prioritize_num_matching_fields,omitempty"`
// PrioritizeTokenPosition Make Typesense prioritize documents where the query words appear earlier in the text.
PrioritizeTokenPosition *bool `json:"prioritize_token_position,omitempty"`
// Q The query text to search for in the collection. Use * as the search string to return all documents. This is typically useful when used in conjunction with filter_by.
Q *string `json:"q,omitempty"`
// QueryBy A list of `string` fields that should be queried against. Multiple fields are separated with a comma.
QueryBy *string `json:"query_by,omitempty"`
// QueryByWeights The relative weight to give each `query_by` field when ranking results. This can be used to boost fields in priority, when looking for matches. Multiple fields are separated with a comma.
QueryByWeights *string `json:"query_by_weights,omitempty"`
// RemoteEmbeddingNumTries Number of times to retry fetching remote embeddings.
RemoteEmbeddingNumTries *int `json:"remote_embedding_num_tries,omitempty"`
// RemoteEmbeddingTimeoutMs Timeout (in milliseconds) for fetching remote embeddings.
RemoteEmbeddingTimeoutMs *int `json:"remote_embedding_timeout_ms,omitempty"`
// SearchCutoffMs Typesense will attempt to return results early if the cutoff time has elapsed. This is not a strict guarantee and facet computation is not bound by this parameter.
SearchCutoffMs *int `json:"search_cutoff_ms,omitempty"`
// SnippetThreshold Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion. Default: 30
SnippetThreshold *int `json:"snippet_threshold,omitempty"`
// SortBy A list of numerical fields and their corresponding sort orders that will be used for ordering your results. Up to 3 sort fields can be specified. The text similarity score is exposed as a special `_text_match` field that you can use in the list of sorting fields. If no `sort_by` parameter is specified, results are sorted by `_text_match:desc,default_sorting_field:desc`
SortBy *string `json:"sort_by,omitempty"`
// SplitJoinTokens Treat space as typo: search for q=basket ball if q=basketball is not found or vice-versa. Splitting/joining of tokens will only be attempted if the original query produces no results. To always trigger this behavior, set value to `always“. To disable, set value to `off`. Default is `fallback`.
SplitJoinTokens *string `json:"split_join_tokens,omitempty"`
// Stopwords Name of the stopwords set to apply for this search, the keywords present in the set will be removed from the search query.
Stopwords *string `json:"stopwords,omitempty"`
// SynonymNumTypos Allow synonym resolution on typo-corrected words in the query. Default: 0
SynonymNumTypos *int `json:"synonym_num_typos,omitempty"`
// SynonymPrefix Allow synonym resolution on word prefixes in the query. Default: false
SynonymPrefix *bool `json:"synonym_prefix,omitempty"`
// TextMatchType In a multi-field matching context, this parameter determines how the representative text match score of a record is calculated. Possible values are max_score (default) or max_weight.
TextMatchType *string `json:"text_match_type,omitempty"`
// TypoTokensThreshold If the number of results found for a specific query is less than this number, Typesense will attempt to look for tokens with more typos until enough results are found. Default: 100
TypoTokensThreshold *int `json:"typo_tokens_threshold,omitempty"`
// UseCache Enable server side caching of search query results. By default, caching is disabled.
UseCache *bool `json:"use_cache,omitempty"`
// VectorQuery Vector query expression for fetching documents "closest" to a given query/document vector.
VectorQuery *string `json:"vector_query,omitempty"`
// VoiceQuery The base64 encoded audio file in 16 khz 16-bit WAV format.
VoiceQuery *string `json:"voice_query,omitempty"`
}
SearchParameters defines model for SearchParameters.
type SearchResult ¶
type SearchResult struct {
Conversation *SearchResultConversation `json:"conversation,omitempty"`
FacetCounts *[]FacetCounts `json:"facet_counts,omitempty"`
// Found The number of documents found
Found *int `json:"found,omitempty"`
FoundDocs *int `json:"found_docs,omitempty"`
GroupedHits *[]SearchGroupedHit `json:"grouped_hits,omitempty"`
// Hits The documents that matched the search query
Hits *[]SearchResultHit `json:"hits,omitempty"`
// OutOf The total number of documents in the collection
OutOf *int `json:"out_of,omitempty"`
// Page The search result page number
Page *int `json:"page,omitempty"`
RequestParams *struct {
CollectionName string `json:"collection_name"`
PerPage int `json:"per_page"`
Q string `json:"q"`
VoiceQuery *struct {
TranscribedQuery *string `json:"transcribed_query,omitempty"`
} `json:"voice_query,omitempty"`
} `json:"request_params,omitempty"`
// SearchCutoff Whether the search was cut off
SearchCutoff *bool `json:"search_cutoff,omitempty"`
// SearchTimeMs The number of milliseconds the search took
SearchTimeMs *int `json:"search_time_ms,omitempty"`
}
SearchResult defines model for SearchResult.
type SearchResultConversation ¶
type SearchResultConversation struct {
Answer string `json:"answer"`
ConversationHistory []map[string]interface{} `json:"conversation_history"`
ConversationId string `json:"conversation_id"`
Query string `json:"query"`
}
SearchResultConversation defines model for SearchResultConversation.
type SearchResultHit ¶
type SearchResultHit struct {
// Document Can be any key-value pair
Document *map[string]interface{} `json:"document,omitempty"`
// GeoDistanceMeters Can be any key-value pair
GeoDistanceMeters *map[string]int `json:"geo_distance_meters,omitempty"`
// Highlight Highlighted version of the matching document
Highlight *map[string]interface{} `json:"highlight,omitempty"`
// Highlights (Deprecated) Contains highlighted portions of the search fields
Highlights *[]SearchHighlight `json:"highlights,omitempty"`
TextMatch *int64 `json:"text_match,omitempty"`
TextMatchInfo *struct {
BestFieldScore *string `json:"best_field_score,omitempty"`
BestFieldWeight *int `json:"best_field_weight,omitempty"`
FieldsMatched *int `json:"fields_matched,omitempty"`
//NumTokensDropped *uint64 `json:"num_tokens_dropped,omitempty"`
Score *string `json:"score,omitempty"`
TokensMatched *int `json:"tokens_matched,omitempty"`
TypoPrefixScore *int `json:"typo_prefix_score,omitempty"`
} `json:"text_match_info,omitempty"`
// VectorDistance Distance between the query vector and matching document's vector value
VectorDistance *float32 `json:"vector_distance,omitempty"`
}
SearchResultHit defines model for SearchResultHit.
type SearchSynonym ¶
type SearchSynonym struct {
Id *string `json:"id,omitempty"`
// Locale Locale for the synonym, leave blank to use the standard tokenizer.
Locale *string `json:"locale,omitempty"`
// Root For 1-way synonyms, indicates the root word that words in the `synonyms` parameter map to.
Root *string `json:"root,omitempty"`
// SymbolsToIndex By default, special characters are dropped from synonyms. Use this attribute to specify which special characters should be indexed as is.
SymbolsToIndex *[]string `json:"symbols_to_index,omitempty"`
// Synonyms Array of words that should be considered as synonyms.
Synonyms []string `json:"synonyms"`
}
SearchSynonym defines model for SearchSynonym.
type SearchSynonymDeleteResponse ¶
type SearchSynonymDeleteResponse struct {
// Id The id of the synonym that was deleted
Id string `json:"id"`
}
SearchSynonymDeleteResponse defines model for SearchSynonymDeleteResponse.
type SearchSynonymSchema ¶
type SearchSynonymSchema struct {
// Locale Locale for the synonym, leave blank to use the standard tokenizer.
Locale *string `json:"locale,omitempty"`
// Root For 1-way synonyms, indicates the root word that words in the `synonyms` parameter map to.
Root *string `json:"root,omitempty"`
// SymbolsToIndex By default, special characters are dropped from synonyms. Use this attribute to specify which special characters should be indexed as is.
SymbolsToIndex *[]string `json:"symbols_to_index,omitempty"`
// Synonyms Array of words that should be considered as synonyms.
Synonyms []string `json:"synonyms"`
}
SearchSynonymSchema defines model for SearchSynonymSchema.
type SearchSynonymsResponse ¶
type SearchSynonymsResponse struct {
Synonyms []*SearchSynonym `json:"synonyms"`
}
SearchSynonymsResponse defines model for SearchSynonymsResponse.
type StemmingDictionary ¶
type StemmingDictionary struct {
// Id Unique identifier for the dictionary
Id string `json:"id"`
// Words List of word mappings in the dictionary
Words []struct {
// Root The root form of the word
Root string `json:"root"`
// Word The word form to be stemmed
Word string `json:"word"`
} `json:"words"`
}
StemmingDictionary defines model for StemmingDictionary.
type StemmingDictionaryWord ¶
type StopwordsSetRetrieveSchema ¶
type StopwordsSetRetrieveSchema struct {
Stopwords StopwordsSetSchema `json:"stopwords"`
}
StopwordsSetRetrieveSchema defines model for StopwordsSetRetrieveSchema.
type StopwordsSetSchema ¶
type StopwordsSetSchema struct {
Id string `json:"id"`
Locale *string `json:"locale,omitempty"`
Stopwords []string `json:"stopwords"`
}
StopwordsSetSchema defines model for StopwordsSetSchema.
type StopwordsSetUpsertSchema ¶
type StopwordsSetUpsertSchema struct {
Locale *string `json:"locale,omitempty"`
Stopwords []string `json:"stopwords"`
}
StopwordsSetUpsertSchema defines model for StopwordsSetUpsertSchema.
type StopwordsSetsRetrieveAllSchema ¶
type StopwordsSetsRetrieveAllSchema struct {
Stopwords []StopwordsSetSchema `json:"stopwords"`
}
StopwordsSetsRetrieveAllSchema defines model for StopwordsSetsRetrieveAllSchema.
type SuccessStatus ¶
type SuccessStatus struct {
Success bool `json:"success"`
}
SuccessStatus defines model for SuccessStatus.
type TakeSnapshotParams ¶
type TakeSnapshotParams struct {
// SnapshotPath The directory on the server where the snapshot should be saved.
SnapshotPath string `form:"snapshot_path" json:"snapshot_path"`
}
TakeSnapshotParams defines parameters for TakeSnapshot.
type TakeSnapshotResponse ¶
type TakeSnapshotResponse struct {
Body []byte
HTTPResponse *http.Response
JSON201 *SuccessStatus
}
func ParseTakeSnapshotResponse ¶
func ParseTakeSnapshotResponse(rsp *http.Response) (*TakeSnapshotResponse, error)
ParseTakeSnapshotResponse parses an HTTP response from a TakeSnapshotWithResponse call
func (TakeSnapshotResponse) Status ¶
func (r TakeSnapshotResponse) Status() string
Status returns HTTPResponse.Status
func (TakeSnapshotResponse) StatusCode ¶
func (r TakeSnapshotResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateCollectionJSONRequestBody ¶
type UpdateCollectionJSONRequestBody = CollectionUpdateSchema
UpdateCollectionJSONRequestBody defines body for UpdateCollection for application/json ContentType.
type UpdateCollectionResponse ¶
type UpdateCollectionResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CollectionUpdateSchema
JSON400 *ApiResponse
JSON404 *ApiResponse
}
func ParseUpdateCollectionResponse ¶
func ParseUpdateCollectionResponse(rsp *http.Response) (*UpdateCollectionResponse, error)
ParseUpdateCollectionResponse parses an HTTP response from a UpdateCollectionWithResponse call
func (UpdateCollectionResponse) Status ¶
func (r UpdateCollectionResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateCollectionResponse) StatusCode ¶
func (r UpdateCollectionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateConversationModelJSONRequestBody ¶
type UpdateConversationModelJSONRequestBody = ConversationModelUpdateSchema
UpdateConversationModelJSONRequestBody defines body for UpdateConversationModel for application/json ContentType.
type UpdateConversationModelResponse ¶
type UpdateConversationModelResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ConversationModelSchema
}
func ParseUpdateConversationModelResponse ¶
func ParseUpdateConversationModelResponse(rsp *http.Response) (*UpdateConversationModelResponse, error)
ParseUpdateConversationModelResponse parses an HTTP response from a UpdateConversationModelWithResponse call
func (UpdateConversationModelResponse) Status ¶
func (r UpdateConversationModelResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateConversationModelResponse) StatusCode ¶
func (r UpdateConversationModelResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateDocumentJSONBody ¶
type UpdateDocumentJSONBody = interface{}
UpdateDocumentJSONBody defines parameters for UpdateDocument.
type UpdateDocumentJSONRequestBody ¶
type UpdateDocumentJSONRequestBody = UpdateDocumentJSONBody
UpdateDocumentJSONRequestBody defines body for UpdateDocument for application/json ContentType.
type UpdateDocumentParams ¶
type UpdateDocumentParams struct {
// DirtyValues Dealing with Dirty Data
DirtyValues *DirtyValues `form:"dirty_values,omitempty" json:"dirty_values,omitempty"`
}
UpdateDocumentParams defines parameters for UpdateDocument.
type UpdateDocumentResponse ¶
type UpdateDocumentResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *map[string]interface{}
JSON404 *ApiResponse
}
func ParseUpdateDocumentResponse ¶
func ParseUpdateDocumentResponse(rsp *http.Response) (*UpdateDocumentResponse, error)
ParseUpdateDocumentResponse parses an HTTP response from a UpdateDocumentWithResponse call
func (UpdateDocumentResponse) Status ¶
func (r UpdateDocumentResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateDocumentResponse) StatusCode ¶
func (r UpdateDocumentResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateDocumentsJSONBody ¶
type UpdateDocumentsJSONBody = interface{}
UpdateDocumentsJSONBody defines parameters for UpdateDocuments.
type UpdateDocumentsJSONRequestBody ¶
type UpdateDocumentsJSONRequestBody = UpdateDocumentsJSONBody
UpdateDocumentsJSONRequestBody defines body for UpdateDocuments for application/json ContentType.
type UpdateDocumentsParams ¶
type UpdateDocumentsParams struct {
FilterBy *string `form:"filter_by,omitempty" json:"filter_by,omitempty"`
}
UpdateDocumentsParams defines parameters for UpdateDocuments.
type UpdateDocumentsResponse ¶
type UpdateDocumentsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
// NumUpdated The number of documents that have been updated
NumUpdated int `json:"num_updated"`
}
JSON400 *ApiResponse
JSON404 *ApiResponse
}
func ParseUpdateDocumentsResponse ¶
func ParseUpdateDocumentsResponse(rsp *http.Response) (*UpdateDocumentsResponse, error)
ParseUpdateDocumentsResponse parses an HTTP response from a UpdateDocumentsWithResponse call
func (UpdateDocumentsResponse) Status ¶
func (r UpdateDocumentsResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateDocumentsResponse) StatusCode ¶
func (r UpdateDocumentsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpsertAliasJSONRequestBody ¶
type UpsertAliasJSONRequestBody = CollectionAliasSchema
UpsertAliasJSONRequestBody defines body for UpsertAlias for application/json ContentType.
type UpsertAliasResponse ¶
type UpsertAliasResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CollectionAlias
JSON400 *ApiResponse
JSON404 *ApiResponse
}
func ParseUpsertAliasResponse ¶
func ParseUpsertAliasResponse(rsp *http.Response) (*UpsertAliasResponse, error)
ParseUpsertAliasResponse parses an HTTP response from a UpsertAliasWithResponse call
func (UpsertAliasResponse) Status ¶
func (r UpsertAliasResponse) Status() string
Status returns HTTPResponse.Status
func (UpsertAliasResponse) StatusCode ¶
func (r UpsertAliasResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpsertAnalyticsRuleJSONRequestBody ¶
type UpsertAnalyticsRuleJSONRequestBody = AnalyticsRuleUpsertSchema
UpsertAnalyticsRuleJSONRequestBody defines body for UpsertAnalyticsRule for application/json ContentType.
type UpsertAnalyticsRuleResponse ¶
type UpsertAnalyticsRuleResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AnalyticsRuleSchema
JSON400 *ApiResponse
}
func ParseUpsertAnalyticsRuleResponse ¶
func ParseUpsertAnalyticsRuleResponse(rsp *http.Response) (*UpsertAnalyticsRuleResponse, error)
ParseUpsertAnalyticsRuleResponse parses an HTTP response from a UpsertAnalyticsRuleWithResponse call
func (UpsertAnalyticsRuleResponse) Status ¶
func (r UpsertAnalyticsRuleResponse) Status() string
Status returns HTTPResponse.Status
func (UpsertAnalyticsRuleResponse) StatusCode ¶
func (r UpsertAnalyticsRuleResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpsertPresetJSONRequestBody ¶
type UpsertPresetJSONRequestBody = PresetUpsertSchema
UpsertPresetJSONRequestBody defines body for UpsertPreset for application/json ContentType.
type UpsertPresetResponse ¶
type UpsertPresetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *PresetSchema
JSON400 *ApiResponse
}
func ParseUpsertPresetResponse ¶
func ParseUpsertPresetResponse(rsp *http.Response) (*UpsertPresetResponse, error)
ParseUpsertPresetResponse parses an HTTP response from a UpsertPresetWithResponse call
func (UpsertPresetResponse) Status ¶
func (r UpsertPresetResponse) Status() string
Status returns HTTPResponse.Status
func (UpsertPresetResponse) StatusCode ¶
func (r UpsertPresetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpsertSearchOverrideJSONRequestBody ¶
type UpsertSearchOverrideJSONRequestBody = SearchOverrideSchema
UpsertSearchOverrideJSONRequestBody defines body for UpsertSearchOverride for application/json ContentType.
type UpsertSearchOverrideResponse ¶
type UpsertSearchOverrideResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SearchOverride
JSON404 *ApiResponse
}
func ParseUpsertSearchOverrideResponse ¶
func ParseUpsertSearchOverrideResponse(rsp *http.Response) (*UpsertSearchOverrideResponse, error)
ParseUpsertSearchOverrideResponse parses an HTTP response from a UpsertSearchOverrideWithResponse call
func (UpsertSearchOverrideResponse) Status ¶
func (r UpsertSearchOverrideResponse) Status() string
Status returns HTTPResponse.Status
func (UpsertSearchOverrideResponse) StatusCode ¶
func (r UpsertSearchOverrideResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpsertSearchSynonymJSONRequestBody ¶
type UpsertSearchSynonymJSONRequestBody = SearchSynonymSchema
UpsertSearchSynonymJSONRequestBody defines body for UpsertSearchSynonym for application/json ContentType.
type UpsertSearchSynonymResponse ¶
type UpsertSearchSynonymResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SearchSynonym
JSON404 *ApiResponse
}
func ParseUpsertSearchSynonymResponse ¶
func ParseUpsertSearchSynonymResponse(rsp *http.Response) (*UpsertSearchSynonymResponse, error)
ParseUpsertSearchSynonymResponse parses an HTTP response from a UpsertSearchSynonymWithResponse call
func (UpsertSearchSynonymResponse) Status ¶
func (r UpsertSearchSynonymResponse) Status() string
Status returns HTTPResponse.Status
func (UpsertSearchSynonymResponse) StatusCode ¶
func (r UpsertSearchSynonymResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpsertStopwordsSetJSONRequestBody ¶
type UpsertStopwordsSetJSONRequestBody = StopwordsSetUpsertSchema
UpsertStopwordsSetJSONRequestBody defines body for UpsertStopwordsSet for application/json ContentType.
type UpsertStopwordsSetResponse ¶
type UpsertStopwordsSetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *StopwordsSetSchema
JSON400 *ApiResponse
}
func ParseUpsertStopwordsSetResponse ¶
func ParseUpsertStopwordsSetResponse(rsp *http.Response) (*UpsertStopwordsSetResponse, error)
ParseUpsertStopwordsSetResponse parses an HTTP response from a UpsertStopwordsSetWithResponse call
func (UpsertStopwordsSetResponse) Status ¶
func (r UpsertStopwordsSetResponse) Status() string
Status returns HTTPResponse.Status
func (UpsertStopwordsSetResponse) StatusCode ¶
func (r UpsertStopwordsSetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type VoiceQueryModelCollectionConfig ¶
type VoiceQueryModelCollectionConfig struct {
ModelName *string `json:"model_name,omitempty"`
}
VoiceQueryModelCollectionConfig Configuration for the voice query model
type VoteResponse ¶
type VoteResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SuccessStatus
}
func ParseVoteResponse ¶
func ParseVoteResponse(rsp *http.Response) (*VoteResponse, error)
ParseVoteResponse parses an HTTP response from a VoteWithResponse call
func (VoteResponse) Status ¶
func (r VoteResponse) Status() string
Status returns HTTPResponse.Status
func (VoteResponse) StatusCode ¶
func (r VoteResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode