Documentation ¶
Overview ¶
Package discoveryv1 : Operations and models for the DiscoveryV1 service
Index ¶
- Constants
- func GetServiceURLForRegion(region string) (string, error)
- func UnmarshalAggregationResult(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalCalculation(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalCollection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalCollectionCrawlStatus(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalCollectionDiskUsage(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalCollectionUsage(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalCompletions(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalConfiguration(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalConversions(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalCreateEventResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalCredentialDetails(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalCredentials(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalCredentialsList(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDeleteCollectionResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDeleteConfigurationResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDeleteCredentials(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDeleteDocumentResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDeleteEnvironmentResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDiskUsage(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDocumentAccepted(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDocumentCounts(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDocumentStatus(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalEnrichment(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalEnrichmentOptions(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalEnvironment(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalEnvironmentDocuments(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalEventData(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalExpansion(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalExpansions(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalField(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalFilter(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalFontSetting(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGateway(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayDelete(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalGatewayList(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalHTMLSettings(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalHistogram(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalIndexCapacity(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalListCollectionFieldsResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalListCollectionsResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalListConfigurationsResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalListEnvironmentsResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalLogQueryResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalLogQueryResponseResult(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalLogQueryResponseResultDocuments(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalLogQueryResponseResultDocumentsResult(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalMetricAggregation(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalMetricAggregationResult(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalMetricResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalMetricTokenAggregation(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalMetricTokenAggregationResult(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalMetricTokenResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalNested(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalNluEnrichmentConcepts(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalNluEnrichmentEmotion(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalNluEnrichmentEntities(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalNluEnrichmentFeatures(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalNluEnrichmentKeywords(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalNluEnrichmentRelations(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalNluEnrichmentSemanticRoles(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalNluEnrichmentSentiment(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalNormalizationOperation(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalNotice(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPDFHeadingDetection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalPDFSettings(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalQueryAggregation(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalQueryNoticesResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalQueryNoticesResult(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalQueryPassages(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalQueryResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalQueryResult(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalQueryResultMetadata(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalRetrievalDetails(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSduStatus(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSduStatusCustomFields(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSearchStatus(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSegmentSettings(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSource(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSourceOptions(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSourceOptionsBuckets(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSourceOptionsFolder(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSourceOptionsObject(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSourceOptionsSiteColl(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSourceOptionsWebCrawl(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSourceSchedule(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSourceStatus(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalStatusDetails(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTerm(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTimeslice(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTokenDictRule(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTokenDictStatusResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTopHits(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTopHitsResults(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTrainingDataSet(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTrainingExample(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTrainingExampleList(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTrainingQuery(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTrainingStatus(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalWordHeadingDetection(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalWordSettings(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalWordStyle(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalXPathPatterns(m map[string]json.RawMessage, result interface{}) (err error)
- type AddDocumentOptions
- func (_options *AddDocumentOptions) SetCollectionID(collectionID string) *AddDocumentOptions
- func (_options *AddDocumentOptions) SetEnvironmentID(environmentID string) *AddDocumentOptions
- func (_options *AddDocumentOptions) SetFile(file io.ReadCloser) *AddDocumentOptions
- func (_options *AddDocumentOptions) SetFileContentType(fileContentType string) *AddDocumentOptions
- func (_options *AddDocumentOptions) SetFilename(filename string) *AddDocumentOptions
- func (options *AddDocumentOptions) SetHeaders(param map[string]string) *AddDocumentOptions
- func (_options *AddDocumentOptions) SetMetadata(metadata string) *AddDocumentOptions
- type AddTrainingDataOptions
- func (_options *AddTrainingDataOptions) SetCollectionID(collectionID string) *AddTrainingDataOptions
- func (_options *AddTrainingDataOptions) SetEnvironmentID(environmentID string) *AddTrainingDataOptions
- func (_options *AddTrainingDataOptions) SetExamples(examples []TrainingExample) *AddTrainingDataOptions
- func (_options *AddTrainingDataOptions) SetFilter(filter string) *AddTrainingDataOptions
- func (options *AddTrainingDataOptions) SetHeaders(param map[string]string) *AddTrainingDataOptions
- func (_options *AddTrainingDataOptions) SetNaturalLanguageQuery(naturalLanguageQuery string) *AddTrainingDataOptions
- type AggregationResult
- type Calculation
- type Collection
- type CollectionCrawlStatus
- type CollectionDiskUsage
- type CollectionUsage
- type Completions
- type Configuration
- type Conversions
- type CreateCollectionOptions
- func (_options *CreateCollectionOptions) SetConfigurationID(configurationID string) *CreateCollectionOptions
- func (_options *CreateCollectionOptions) SetDescription(description string) *CreateCollectionOptions
- func (_options *CreateCollectionOptions) SetEnvironmentID(environmentID string) *CreateCollectionOptions
- func (options *CreateCollectionOptions) SetHeaders(param map[string]string) *CreateCollectionOptions
- func (_options *CreateCollectionOptions) SetLanguage(language string) *CreateCollectionOptions
- func (_options *CreateCollectionOptions) SetName(name string) *CreateCollectionOptions
- type CreateConfigurationOptions
- func (_options *CreateConfigurationOptions) SetConversions(conversions *Conversions) *CreateConfigurationOptions
- func (_options *CreateConfigurationOptions) SetDescription(description string) *CreateConfigurationOptions
- func (_options *CreateConfigurationOptions) SetEnrichments(enrichments []Enrichment) *CreateConfigurationOptions
- func (_options *CreateConfigurationOptions) SetEnvironmentID(environmentID string) *CreateConfigurationOptions
- func (options *CreateConfigurationOptions) SetHeaders(param map[string]string) *CreateConfigurationOptions
- func (_options *CreateConfigurationOptions) SetName(name string) *CreateConfigurationOptions
- func (_options *CreateConfigurationOptions) SetNormalizations(normalizations []NormalizationOperation) *CreateConfigurationOptions
- func (_options *CreateConfigurationOptions) SetSource(source *Source) *CreateConfigurationOptions
- type CreateCredentialsOptions
- func (_options *CreateCredentialsOptions) SetCredentialDetails(credentialDetails *CredentialDetails) *CreateCredentialsOptions
- func (_options *CreateCredentialsOptions) SetEnvironmentID(environmentID string) *CreateCredentialsOptions
- func (options *CreateCredentialsOptions) SetHeaders(param map[string]string) *CreateCredentialsOptions
- func (_options *CreateCredentialsOptions) SetSourceType(sourceType string) *CreateCredentialsOptions
- func (_options *CreateCredentialsOptions) SetStatus(status *StatusDetails) *CreateCredentialsOptions
- type CreateEnvironmentOptions
- func (_options *CreateEnvironmentOptions) SetDescription(description string) *CreateEnvironmentOptions
- func (options *CreateEnvironmentOptions) SetHeaders(param map[string]string) *CreateEnvironmentOptions
- func (_options *CreateEnvironmentOptions) SetName(name string) *CreateEnvironmentOptions
- func (_options *CreateEnvironmentOptions) SetSize(size string) *CreateEnvironmentOptions
- type CreateEventOptions
- type CreateEventResponse
- type CreateExpansionsOptions
- func (_options *CreateExpansionsOptions) SetCollectionID(collectionID string) *CreateExpansionsOptions
- func (_options *CreateExpansionsOptions) SetEnvironmentID(environmentID string) *CreateExpansionsOptions
- func (_options *CreateExpansionsOptions) SetExpansions(expansions []Expansion) *CreateExpansionsOptions
- func (options *CreateExpansionsOptions) SetHeaders(param map[string]string) *CreateExpansionsOptions
- type CreateGatewayOptions
- type CreateStopwordListOptions
- func (_options *CreateStopwordListOptions) SetCollectionID(collectionID string) *CreateStopwordListOptions
- func (_options *CreateStopwordListOptions) SetEnvironmentID(environmentID string) *CreateStopwordListOptions
- func (options *CreateStopwordListOptions) SetHeaders(param map[string]string) *CreateStopwordListOptions
- func (_options *CreateStopwordListOptions) SetStopwordFile(stopwordFile io.ReadCloser) *CreateStopwordListOptions
- func (_options *CreateStopwordListOptions) SetStopwordFilename(stopwordFilename string) *CreateStopwordListOptions
- type CreateTokenizationDictionaryOptions
- func (_options *CreateTokenizationDictionaryOptions) SetCollectionID(collectionID string) *CreateTokenizationDictionaryOptions
- func (_options *CreateTokenizationDictionaryOptions) SetEnvironmentID(environmentID string) *CreateTokenizationDictionaryOptions
- func (options *CreateTokenizationDictionaryOptions) SetHeaders(param map[string]string) *CreateTokenizationDictionaryOptions
- func (_options *CreateTokenizationDictionaryOptions) SetTokenizationRules(tokenizationRules []TokenDictRule) *CreateTokenizationDictionaryOptions
- type CreateTrainingExampleOptions
- func (_options *CreateTrainingExampleOptions) SetCollectionID(collectionID string) *CreateTrainingExampleOptions
- func (_options *CreateTrainingExampleOptions) SetCrossReference(crossReference string) *CreateTrainingExampleOptions
- func (_options *CreateTrainingExampleOptions) SetDocumentID(documentID string) *CreateTrainingExampleOptions
- func (_options *CreateTrainingExampleOptions) SetEnvironmentID(environmentID string) *CreateTrainingExampleOptions
- func (options *CreateTrainingExampleOptions) SetHeaders(param map[string]string) *CreateTrainingExampleOptions
- func (_options *CreateTrainingExampleOptions) SetQueryID(queryID string) *CreateTrainingExampleOptions
- func (_options *CreateTrainingExampleOptions) SetRelevance(relevance int64) *CreateTrainingExampleOptions
- type CredentialDetails
- type Credentials
- type CredentialsList
- type DeleteAllTrainingDataOptions
- func (_options *DeleteAllTrainingDataOptions) SetCollectionID(collectionID string) *DeleteAllTrainingDataOptions
- func (_options *DeleteAllTrainingDataOptions) SetEnvironmentID(environmentID string) *DeleteAllTrainingDataOptions
- func (options *DeleteAllTrainingDataOptions) SetHeaders(param map[string]string) *DeleteAllTrainingDataOptions
- type DeleteCollectionOptions
- func (_options *DeleteCollectionOptions) SetCollectionID(collectionID string) *DeleteCollectionOptions
- func (_options *DeleteCollectionOptions) SetEnvironmentID(environmentID string) *DeleteCollectionOptions
- func (options *DeleteCollectionOptions) SetHeaders(param map[string]string) *DeleteCollectionOptions
- type DeleteCollectionResponse
- type DeleteConfigurationOptions
- func (_options *DeleteConfigurationOptions) SetConfigurationID(configurationID string) *DeleteConfigurationOptions
- func (_options *DeleteConfigurationOptions) SetEnvironmentID(environmentID string) *DeleteConfigurationOptions
- func (options *DeleteConfigurationOptions) SetHeaders(param map[string]string) *DeleteConfigurationOptions
- type DeleteConfigurationResponse
- type DeleteCredentials
- type DeleteCredentialsOptions
- func (_options *DeleteCredentialsOptions) SetCredentialID(credentialID string) *DeleteCredentialsOptions
- func (_options *DeleteCredentialsOptions) SetEnvironmentID(environmentID string) *DeleteCredentialsOptions
- func (options *DeleteCredentialsOptions) SetHeaders(param map[string]string) *DeleteCredentialsOptions
- type DeleteDocumentOptions
- func (_options *DeleteDocumentOptions) SetCollectionID(collectionID string) *DeleteDocumentOptions
- func (_options *DeleteDocumentOptions) SetDocumentID(documentID string) *DeleteDocumentOptions
- func (_options *DeleteDocumentOptions) SetEnvironmentID(environmentID string) *DeleteDocumentOptions
- func (options *DeleteDocumentOptions) SetHeaders(param map[string]string) *DeleteDocumentOptions
- type DeleteDocumentResponse
- type DeleteEnvironmentOptions
- type DeleteEnvironmentResponse
- type DeleteExpansionsOptions
- func (_options *DeleteExpansionsOptions) SetCollectionID(collectionID string) *DeleteExpansionsOptions
- func (_options *DeleteExpansionsOptions) SetEnvironmentID(environmentID string) *DeleteExpansionsOptions
- func (options *DeleteExpansionsOptions) SetHeaders(param map[string]string) *DeleteExpansionsOptions
- type DeleteGatewayOptions
- type DeleteStopwordListOptions
- func (_options *DeleteStopwordListOptions) SetCollectionID(collectionID string) *DeleteStopwordListOptions
- func (_options *DeleteStopwordListOptions) SetEnvironmentID(environmentID string) *DeleteStopwordListOptions
- func (options *DeleteStopwordListOptions) SetHeaders(param map[string]string) *DeleteStopwordListOptions
- type DeleteTokenizationDictionaryOptions
- func (_options *DeleteTokenizationDictionaryOptions) SetCollectionID(collectionID string) *DeleteTokenizationDictionaryOptions
- func (_options *DeleteTokenizationDictionaryOptions) SetEnvironmentID(environmentID string) *DeleteTokenizationDictionaryOptions
- func (options *DeleteTokenizationDictionaryOptions) SetHeaders(param map[string]string) *DeleteTokenizationDictionaryOptions
- type DeleteTrainingDataOptions
- func (_options *DeleteTrainingDataOptions) SetCollectionID(collectionID string) *DeleteTrainingDataOptions
- func (_options *DeleteTrainingDataOptions) SetEnvironmentID(environmentID string) *DeleteTrainingDataOptions
- func (options *DeleteTrainingDataOptions) SetHeaders(param map[string]string) *DeleteTrainingDataOptions
- func (_options *DeleteTrainingDataOptions) SetQueryID(queryID string) *DeleteTrainingDataOptions
- type DeleteTrainingExampleOptions
- func (_options *DeleteTrainingExampleOptions) SetCollectionID(collectionID string) *DeleteTrainingExampleOptions
- func (_options *DeleteTrainingExampleOptions) SetEnvironmentID(environmentID string) *DeleteTrainingExampleOptions
- func (_options *DeleteTrainingExampleOptions) SetExampleID(exampleID string) *DeleteTrainingExampleOptions
- func (options *DeleteTrainingExampleOptions) SetHeaders(param map[string]string) *DeleteTrainingExampleOptions
- func (_options *DeleteTrainingExampleOptions) SetQueryID(queryID string) *DeleteTrainingExampleOptions
- type DeleteUserDataOptions
- type DiscoveryV1
- func (discovery *DiscoveryV1) AddDocument(addDocumentOptions *AddDocumentOptions) (result *DocumentAccepted, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) AddDocumentWithContext(ctx context.Context, addDocumentOptions *AddDocumentOptions) (result *DocumentAccepted, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) AddTrainingData(addTrainingDataOptions *AddTrainingDataOptions) (result *TrainingQuery, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) AddTrainingDataWithContext(ctx context.Context, addTrainingDataOptions *AddTrainingDataOptions) (result *TrainingQuery, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) Clone() *DiscoveryV1
- func (discovery *DiscoveryV1) CreateCollection(createCollectionOptions *CreateCollectionOptions) (result *Collection, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateCollectionWithContext(ctx context.Context, createCollectionOptions *CreateCollectionOptions) (result *Collection, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateConfiguration(createConfigurationOptions *CreateConfigurationOptions) (result *Configuration, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateConfigurationWithContext(ctx context.Context, createConfigurationOptions *CreateConfigurationOptions) (result *Configuration, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateCredentials(createCredentialsOptions *CreateCredentialsOptions) (result *Credentials, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateCredentialsWithContext(ctx context.Context, createCredentialsOptions *CreateCredentialsOptions) (result *Credentials, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateEnvironment(createEnvironmentOptions *CreateEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateEnvironmentWithContext(ctx context.Context, createEnvironmentOptions *CreateEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateEvent(createEventOptions *CreateEventOptions) (result *CreateEventResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateEventWithContext(ctx context.Context, createEventOptions *CreateEventOptions) (result *CreateEventResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateExpansions(createExpansionsOptions *CreateExpansionsOptions) (result *Expansions, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateExpansionsWithContext(ctx context.Context, createExpansionsOptions *CreateExpansionsOptions) (result *Expansions, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateGateway(createGatewayOptions *CreateGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateGatewayWithContext(ctx context.Context, createGatewayOptions *CreateGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateStopwordList(createStopwordListOptions *CreateStopwordListOptions) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateStopwordListWithContext(ctx context.Context, createStopwordListOptions *CreateStopwordListOptions) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateTokenizationDictionary(createTokenizationDictionaryOptions *CreateTokenizationDictionaryOptions) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateTokenizationDictionaryWithContext(ctx context.Context, ...) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateTrainingExample(createTrainingExampleOptions *CreateTrainingExampleOptions) (result *TrainingExample, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) CreateTrainingExampleWithContext(ctx context.Context, ...) (result *TrainingExample, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteAllTrainingData(deleteAllTrainingDataOptions *DeleteAllTrainingDataOptions) (response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteAllTrainingDataWithContext(ctx context.Context, ...) (response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteCollection(deleteCollectionOptions *DeleteCollectionOptions) (result *DeleteCollectionResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteCollectionWithContext(ctx context.Context, deleteCollectionOptions *DeleteCollectionOptions) (result *DeleteCollectionResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteConfiguration(deleteConfigurationOptions *DeleteConfigurationOptions) (result *DeleteConfigurationResponse, response *core.DetailedResponse, ...)
- func (discovery *DiscoveryV1) DeleteConfigurationWithContext(ctx context.Context, deleteConfigurationOptions *DeleteConfigurationOptions) (result *DeleteConfigurationResponse, response *core.DetailedResponse, ...)
- func (discovery *DiscoveryV1) DeleteCredentials(deleteCredentialsOptions *DeleteCredentialsOptions) (result *DeleteCredentials, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteCredentialsWithContext(ctx context.Context, deleteCredentialsOptions *DeleteCredentialsOptions) (result *DeleteCredentials, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteDocument(deleteDocumentOptions *DeleteDocumentOptions) (result *DeleteDocumentResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteDocumentWithContext(ctx context.Context, deleteDocumentOptions *DeleteDocumentOptions) (result *DeleteDocumentResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteEnvironment(deleteEnvironmentOptions *DeleteEnvironmentOptions) (result *DeleteEnvironmentResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteEnvironmentWithContext(ctx context.Context, deleteEnvironmentOptions *DeleteEnvironmentOptions) (result *DeleteEnvironmentResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteExpansions(deleteExpansionsOptions *DeleteExpansionsOptions) (response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteExpansionsWithContext(ctx context.Context, deleteExpansionsOptions *DeleteExpansionsOptions) (response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteGateway(deleteGatewayOptions *DeleteGatewayOptions) (result *GatewayDelete, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteGatewayWithContext(ctx context.Context, deleteGatewayOptions *DeleteGatewayOptions) (result *GatewayDelete, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteStopwordList(deleteStopwordListOptions *DeleteStopwordListOptions) (response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteStopwordListWithContext(ctx context.Context, deleteStopwordListOptions *DeleteStopwordListOptions) (response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteTokenizationDictionary(deleteTokenizationDictionaryOptions *DeleteTokenizationDictionaryOptions) (response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteTokenizationDictionaryWithContext(ctx context.Context, ...) (response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteTrainingData(deleteTrainingDataOptions *DeleteTrainingDataOptions) (response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteTrainingDataWithContext(ctx context.Context, deleteTrainingDataOptions *DeleteTrainingDataOptions) (response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteTrainingExample(deleteTrainingExampleOptions *DeleteTrainingExampleOptions) (response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteTrainingExampleWithContext(ctx context.Context, ...) (response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteUserData(deleteUserDataOptions *DeleteUserDataOptions) (response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DeleteUserDataWithContext(ctx context.Context, deleteUserDataOptions *DeleteUserDataOptions) (response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) DisableRetries()
- func (discovery *DiscoveryV1) DisableSSLVerification()
- func (discovery *DiscoveryV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)
- func (discovery *DiscoveryV1) FederatedQuery(federatedQueryOptions *FederatedQueryOptions) (result *QueryResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) FederatedQueryNotices(federatedQueryNoticesOptions *FederatedQueryNoticesOptions) (result *QueryNoticesResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) FederatedQueryNoticesWithContext(ctx context.Context, ...) (result *QueryNoticesResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) FederatedQueryWithContext(ctx context.Context, federatedQueryOptions *FederatedQueryOptions) (result *QueryResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetAutocompletion(getAutocompletionOptions *GetAutocompletionOptions) (result *Completions, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetAutocompletionWithContext(ctx context.Context, getAutocompletionOptions *GetAutocompletionOptions) (result *Completions, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetCollection(getCollectionOptions *GetCollectionOptions) (result *Collection, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetCollectionWithContext(ctx context.Context, getCollectionOptions *GetCollectionOptions) (result *Collection, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetConfiguration(getConfigurationOptions *GetConfigurationOptions) (result *Configuration, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetConfigurationWithContext(ctx context.Context, getConfigurationOptions *GetConfigurationOptions) (result *Configuration, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetCredentials(getCredentialsOptions *GetCredentialsOptions) (result *Credentials, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetCredentialsWithContext(ctx context.Context, getCredentialsOptions *GetCredentialsOptions) (result *Credentials, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetDocumentStatus(getDocumentStatusOptions *GetDocumentStatusOptions) (result *DocumentStatus, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetDocumentStatusWithContext(ctx context.Context, getDocumentStatusOptions *GetDocumentStatusOptions) (result *DocumentStatus, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetEnableGzipCompression() bool
- func (discovery *DiscoveryV1) GetEnvironment(getEnvironmentOptions *GetEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetEnvironmentWithContext(ctx context.Context, getEnvironmentOptions *GetEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetGateway(getGatewayOptions *GetGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetGatewayWithContext(ctx context.Context, getGatewayOptions *GetGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetMetricsEventRate(getMetricsEventRateOptions *GetMetricsEventRateOptions) (result *MetricResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetMetricsEventRateWithContext(ctx context.Context, getMetricsEventRateOptions *GetMetricsEventRateOptions) (result *MetricResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetMetricsQuery(getMetricsQueryOptions *GetMetricsQueryOptions) (result *MetricResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetMetricsQueryEvent(getMetricsQueryEventOptions *GetMetricsQueryEventOptions) (result *MetricResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetMetricsQueryEventWithContext(ctx context.Context, getMetricsQueryEventOptions *GetMetricsQueryEventOptions) (result *MetricResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetMetricsQueryNoResults(getMetricsQueryNoResultsOptions *GetMetricsQueryNoResultsOptions) (result *MetricResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetMetricsQueryNoResultsWithContext(ctx context.Context, ...) (result *MetricResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetMetricsQueryTokenEvent(getMetricsQueryTokenEventOptions *GetMetricsQueryTokenEventOptions) (result *MetricTokenResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetMetricsQueryTokenEventWithContext(ctx context.Context, ...) (result *MetricTokenResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetMetricsQueryWithContext(ctx context.Context, getMetricsQueryOptions *GetMetricsQueryOptions) (result *MetricResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetServiceURL() string
- func (discovery *DiscoveryV1) GetStopwordListStatus(getStopwordListStatusOptions *GetStopwordListStatusOptions) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetStopwordListStatusWithContext(ctx context.Context, ...) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetTokenizationDictionaryStatus(getTokenizationDictionaryStatusOptions *GetTokenizationDictionaryStatusOptions) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetTokenizationDictionaryStatusWithContext(ctx context.Context, ...) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetTrainingData(getTrainingDataOptions *GetTrainingDataOptions) (result *TrainingQuery, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetTrainingDataWithContext(ctx context.Context, getTrainingDataOptions *GetTrainingDataOptions) (result *TrainingQuery, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetTrainingExample(getTrainingExampleOptions *GetTrainingExampleOptions) (result *TrainingExample, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) GetTrainingExampleWithContext(ctx context.Context, getTrainingExampleOptions *GetTrainingExampleOptions) (result *TrainingExample, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListCollectionFields(listCollectionFieldsOptions *ListCollectionFieldsOptions) (result *ListCollectionFieldsResponse, response *core.DetailedResponse, ...)
- func (discovery *DiscoveryV1) ListCollectionFieldsWithContext(ctx context.Context, listCollectionFieldsOptions *ListCollectionFieldsOptions) (result *ListCollectionFieldsResponse, response *core.DetailedResponse, ...)
- func (discovery *DiscoveryV1) ListCollections(listCollectionsOptions *ListCollectionsOptions) (result *ListCollectionsResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListCollectionsWithContext(ctx context.Context, listCollectionsOptions *ListCollectionsOptions) (result *ListCollectionsResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListConfigurations(listConfigurationsOptions *ListConfigurationsOptions) (result *ListConfigurationsResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListConfigurationsWithContext(ctx context.Context, listConfigurationsOptions *ListConfigurationsOptions) (result *ListConfigurationsResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListCredentials(listCredentialsOptions *ListCredentialsOptions) (result *CredentialsList, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListCredentialsWithContext(ctx context.Context, listCredentialsOptions *ListCredentialsOptions) (result *CredentialsList, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListEnvironments(listEnvironmentsOptions *ListEnvironmentsOptions) (result *ListEnvironmentsResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListEnvironmentsWithContext(ctx context.Context, listEnvironmentsOptions *ListEnvironmentsOptions) (result *ListEnvironmentsResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListExpansions(listExpansionsOptions *ListExpansionsOptions) (result *Expansions, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListExpansionsWithContext(ctx context.Context, listExpansionsOptions *ListExpansionsOptions) (result *Expansions, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListFields(listFieldsOptions *ListFieldsOptions) (result *ListCollectionFieldsResponse, response *core.DetailedResponse, ...)
- func (discovery *DiscoveryV1) ListFieldsWithContext(ctx context.Context, listFieldsOptions *ListFieldsOptions) (result *ListCollectionFieldsResponse, response *core.DetailedResponse, ...)
- func (discovery *DiscoveryV1) ListGateways(listGatewaysOptions *ListGatewaysOptions) (result *GatewayList, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListGatewaysWithContext(ctx context.Context, listGatewaysOptions *ListGatewaysOptions) (result *GatewayList, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListTrainingData(listTrainingDataOptions *ListTrainingDataOptions) (result *TrainingDataSet, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListTrainingDataWithContext(ctx context.Context, listTrainingDataOptions *ListTrainingDataOptions) (result *TrainingDataSet, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListTrainingExamples(listTrainingExamplesOptions *ListTrainingExamplesOptions) (result *TrainingExampleList, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) ListTrainingExamplesWithContext(ctx context.Context, listTrainingExamplesOptions *ListTrainingExamplesOptions) (result *TrainingExampleList, response *core.DetailedResponse, err error)
- func (*DiscoveryV1) NewAddDocumentOptions(environmentID string, collectionID string) *AddDocumentOptions
- func (*DiscoveryV1) NewAddTrainingDataOptions(environmentID string, collectionID string) *AddTrainingDataOptions
- func (*DiscoveryV1) NewConfiguration(name string) (_model *Configuration, err error)
- func (*DiscoveryV1) NewCreateCollectionOptions(environmentID string, name string) *CreateCollectionOptions
- func (*DiscoveryV1) NewCreateConfigurationOptions(environmentID string, name string) *CreateConfigurationOptions
- func (*DiscoveryV1) NewCreateCredentialsOptions(environmentID string) *CreateCredentialsOptions
- func (*DiscoveryV1) NewCreateEnvironmentOptions(name string) *CreateEnvironmentOptions
- func (*DiscoveryV1) NewCreateEventOptions(typeVar string, data *EventData) *CreateEventOptions
- func (*DiscoveryV1) NewCreateExpansionsOptions(environmentID string, collectionID string, expansions []Expansion) *CreateExpansionsOptions
- func (*DiscoveryV1) NewCreateGatewayOptions(environmentID string) *CreateGatewayOptions
- func (*DiscoveryV1) NewCreateStopwordListOptions(environmentID string, collectionID string, stopwordFile io.ReadCloser, ...) *CreateStopwordListOptions
- func (*DiscoveryV1) NewCreateTokenizationDictionaryOptions(environmentID string, collectionID string) *CreateTokenizationDictionaryOptions
- func (*DiscoveryV1) NewCreateTrainingExampleOptions(environmentID string, collectionID string, queryID string) *CreateTrainingExampleOptions
- func (*DiscoveryV1) NewDeleteAllTrainingDataOptions(environmentID string, collectionID string) *DeleteAllTrainingDataOptions
- func (*DiscoveryV1) NewDeleteCollectionOptions(environmentID string, collectionID string) *DeleteCollectionOptions
- func (*DiscoveryV1) NewDeleteConfigurationOptions(environmentID string, configurationID string) *DeleteConfigurationOptions
- func (*DiscoveryV1) NewDeleteCredentialsOptions(environmentID string, credentialID string) *DeleteCredentialsOptions
- func (*DiscoveryV1) NewDeleteDocumentOptions(environmentID string, collectionID string, documentID string) *DeleteDocumentOptions
- func (*DiscoveryV1) NewDeleteEnvironmentOptions(environmentID string) *DeleteEnvironmentOptions
- func (*DiscoveryV1) NewDeleteExpansionsOptions(environmentID string, collectionID string) *DeleteExpansionsOptions
- func (*DiscoveryV1) NewDeleteGatewayOptions(environmentID string, gatewayID string) *DeleteGatewayOptions
- func (*DiscoveryV1) NewDeleteStopwordListOptions(environmentID string, collectionID string) *DeleteStopwordListOptions
- func (*DiscoveryV1) NewDeleteTokenizationDictionaryOptions(environmentID string, collectionID string) *DeleteTokenizationDictionaryOptions
- func (*DiscoveryV1) NewDeleteTrainingDataOptions(environmentID string, collectionID string, queryID string) *DeleteTrainingDataOptions
- func (*DiscoveryV1) NewDeleteTrainingExampleOptions(environmentID string, collectionID string, queryID string, exampleID string) *DeleteTrainingExampleOptions
- func (*DiscoveryV1) NewDeleteUserDataOptions(customerID string) *DeleteUserDataOptions
- func (*DiscoveryV1) NewEnrichment(destinationField string, sourceField string, enrichment string) (_model *Enrichment, err error)
- func (*DiscoveryV1) NewEventData(environmentID string, sessionToken string, collectionID string, ...) (_model *EventData, err error)
- func (*DiscoveryV1) NewExpansion(expandedTerms []string) (_model *Expansion, err error)
- func (*DiscoveryV1) NewExpansions(expansions []Expansion) (_model *Expansions, err error)
- func (*DiscoveryV1) NewFederatedQueryNoticesOptions(environmentID string, collectionIds []string) *FederatedQueryNoticesOptions
- func (*DiscoveryV1) NewFederatedQueryOptions(environmentID string, collectionIds string) *FederatedQueryOptions
- func (*DiscoveryV1) NewGetAutocompletionOptions(environmentID string, collectionID string, prefix string) *GetAutocompletionOptions
- func (*DiscoveryV1) NewGetCollectionOptions(environmentID string, collectionID string) *GetCollectionOptions
- func (*DiscoveryV1) NewGetConfigurationOptions(environmentID string, configurationID string) *GetConfigurationOptions
- func (*DiscoveryV1) NewGetCredentialsOptions(environmentID string, credentialID string) *GetCredentialsOptions
- func (*DiscoveryV1) NewGetDocumentStatusOptions(environmentID string, collectionID string, documentID string) *GetDocumentStatusOptions
- func (*DiscoveryV1) NewGetEnvironmentOptions(environmentID string) *GetEnvironmentOptions
- func (*DiscoveryV1) NewGetGatewayOptions(environmentID string, gatewayID string) *GetGatewayOptions
- func (*DiscoveryV1) NewGetMetricsEventRateOptions() *GetMetricsEventRateOptions
- func (*DiscoveryV1) NewGetMetricsQueryEventOptions() *GetMetricsQueryEventOptions
- func (*DiscoveryV1) NewGetMetricsQueryNoResultsOptions() *GetMetricsQueryNoResultsOptions
- func (*DiscoveryV1) NewGetMetricsQueryOptions() *GetMetricsQueryOptions
- func (*DiscoveryV1) NewGetMetricsQueryTokenEventOptions() *GetMetricsQueryTokenEventOptions
- func (*DiscoveryV1) NewGetStopwordListStatusOptions(environmentID string, collectionID string) *GetStopwordListStatusOptions
- func (*DiscoveryV1) NewGetTokenizationDictionaryStatusOptions(environmentID string, collectionID string) *GetTokenizationDictionaryStatusOptions
- func (*DiscoveryV1) NewGetTrainingDataOptions(environmentID string, collectionID string, queryID string) *GetTrainingDataOptions
- func (*DiscoveryV1) NewGetTrainingExampleOptions(environmentID string, collectionID string, queryID string, exampleID string) *GetTrainingExampleOptions
- func (*DiscoveryV1) NewListCollectionFieldsOptions(environmentID string, collectionID string) *ListCollectionFieldsOptions
- func (*DiscoveryV1) NewListCollectionsOptions(environmentID string) *ListCollectionsOptions
- func (*DiscoveryV1) NewListConfigurationsOptions(environmentID string) *ListConfigurationsOptions
- func (*DiscoveryV1) NewListCredentialsOptions(environmentID string) *ListCredentialsOptions
- func (*DiscoveryV1) NewListEnvironmentsOptions() *ListEnvironmentsOptions
- func (*DiscoveryV1) NewListExpansionsOptions(environmentID string, collectionID string) *ListExpansionsOptions
- func (*DiscoveryV1) NewListFieldsOptions(environmentID string, collectionIds []string) *ListFieldsOptions
- func (*DiscoveryV1) NewListGatewaysOptions(environmentID string) *ListGatewaysOptions
- func (*DiscoveryV1) NewListTrainingDataOptions(environmentID string, collectionID string) *ListTrainingDataOptions
- func (*DiscoveryV1) NewListTrainingExamplesOptions(environmentID string, collectionID string, queryID string) *ListTrainingExamplesOptions
- func (*DiscoveryV1) NewQueryLogOptions() *QueryLogOptions
- func (*DiscoveryV1) NewQueryNoticesOptions(environmentID string, collectionID string) *QueryNoticesOptions
- func (*DiscoveryV1) NewQueryOptions(environmentID string, collectionID string) *QueryOptions
- func (*DiscoveryV1) NewSourceOptionsBuckets(name string) (_model *SourceOptionsBuckets, err error)
- func (*DiscoveryV1) NewSourceOptionsFolder(ownerUserID string, folderID string) (_model *SourceOptionsFolder, err error)
- func (*DiscoveryV1) NewSourceOptionsObject(name string) (_model *SourceOptionsObject, err error)
- func (*DiscoveryV1) NewSourceOptionsSiteColl(siteCollectionPath string) (_model *SourceOptionsSiteColl, err error)
- func (*DiscoveryV1) NewSourceOptionsWebCrawl(url string) (_model *SourceOptionsWebCrawl, err error)
- func (*DiscoveryV1) NewTokenDictRule(text string, tokens []string, partOfSpeech string) (_model *TokenDictRule, err error)
- func (*DiscoveryV1) NewUpdateCollectionOptions(environmentID string, collectionID string, name string) *UpdateCollectionOptions
- func (*DiscoveryV1) NewUpdateConfigurationOptions(environmentID string, configurationID string, name string) *UpdateConfigurationOptions
- func (*DiscoveryV1) NewUpdateCredentialsOptions(environmentID string, credentialID string) *UpdateCredentialsOptions
- func (*DiscoveryV1) NewUpdateDocumentOptions(environmentID string, collectionID string, documentID string) *UpdateDocumentOptions
- func (*DiscoveryV1) NewUpdateEnvironmentOptions(environmentID string) *UpdateEnvironmentOptions
- func (*DiscoveryV1) NewUpdateTrainingExampleOptions(environmentID string, collectionID string, queryID string, exampleID string) *UpdateTrainingExampleOptions
- func (discovery *DiscoveryV1) Query(queryOptions *QueryOptions) (result *QueryResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) QueryLog(queryLogOptions *QueryLogOptions) (result *LogQueryResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) QueryLogWithContext(ctx context.Context, queryLogOptions *QueryLogOptions) (result *LogQueryResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) QueryNotices(queryNoticesOptions *QueryNoticesOptions) (result *QueryNoticesResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) QueryNoticesWithContext(ctx context.Context, queryNoticesOptions *QueryNoticesOptions) (result *QueryNoticesResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) QueryWithContext(ctx context.Context, queryOptions *QueryOptions) (result *QueryResponse, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) SetDefaultHeaders(headers http.Header)
- func (discovery *DiscoveryV1) SetEnableGzipCompression(enableGzip bool)
- func (discovery *DiscoveryV1) SetServiceURL(url string) error
- func (discovery *DiscoveryV1) UpdateCollection(updateCollectionOptions *UpdateCollectionOptions) (result *Collection, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) UpdateCollectionWithContext(ctx context.Context, updateCollectionOptions *UpdateCollectionOptions) (result *Collection, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) UpdateConfiguration(updateConfigurationOptions *UpdateConfigurationOptions) (result *Configuration, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) UpdateConfigurationWithContext(ctx context.Context, updateConfigurationOptions *UpdateConfigurationOptions) (result *Configuration, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) UpdateCredentials(updateCredentialsOptions *UpdateCredentialsOptions) (result *Credentials, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) UpdateCredentialsWithContext(ctx context.Context, updateCredentialsOptions *UpdateCredentialsOptions) (result *Credentials, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) UpdateDocument(updateDocumentOptions *UpdateDocumentOptions) (result *DocumentAccepted, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) UpdateDocumentWithContext(ctx context.Context, updateDocumentOptions *UpdateDocumentOptions) (result *DocumentAccepted, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) UpdateEnvironment(updateEnvironmentOptions *UpdateEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) UpdateEnvironmentWithContext(ctx context.Context, updateEnvironmentOptions *UpdateEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) UpdateTrainingExample(updateTrainingExampleOptions *UpdateTrainingExampleOptions) (result *TrainingExample, response *core.DetailedResponse, err error)
- func (discovery *DiscoveryV1) UpdateTrainingExampleWithContext(ctx context.Context, ...) (result *TrainingExample, response *core.DetailedResponse, err error)
- type DiscoveryV1Options
- type DiskUsage
- type DocumentAccepted
- type DocumentCounts
- type DocumentStatus
- type Enrichment
- type EnrichmentOptions
- type Environment
- type EnvironmentDocuments
- type EventData
- type Expansion
- type Expansions
- type FederatedQueryNoticesOptions
- func (_options *FederatedQueryNoticesOptions) SetAggregation(aggregation string) *FederatedQueryNoticesOptions
- func (_options *FederatedQueryNoticesOptions) SetCollectionIds(collectionIds []string) *FederatedQueryNoticesOptions
- func (_options *FederatedQueryNoticesOptions) SetCount(count int64) *FederatedQueryNoticesOptions
- func (_options *FederatedQueryNoticesOptions) SetDeduplicateField(deduplicateField string) *FederatedQueryNoticesOptions
- func (_options *FederatedQueryNoticesOptions) SetEnvironmentID(environmentID string) *FederatedQueryNoticesOptions
- func (_options *FederatedQueryNoticesOptions) SetFilter(filter string) *FederatedQueryNoticesOptions
- func (options *FederatedQueryNoticesOptions) SetHeaders(param map[string]string) *FederatedQueryNoticesOptions
- func (_options *FederatedQueryNoticesOptions) SetHighlight(highlight bool) *FederatedQueryNoticesOptions
- func (_options *FederatedQueryNoticesOptions) SetNaturalLanguageQuery(naturalLanguageQuery string) *FederatedQueryNoticesOptions
- func (_options *FederatedQueryNoticesOptions) SetOffset(offset int64) *FederatedQueryNoticesOptions
- func (_options *FederatedQueryNoticesOptions) SetQuery(query string) *FederatedQueryNoticesOptions
- func (_options *FederatedQueryNoticesOptions) SetReturn(returnVar []string) *FederatedQueryNoticesOptions
- func (_options *FederatedQueryNoticesOptions) SetSimilar(similar bool) *FederatedQueryNoticesOptions
- func (_options *FederatedQueryNoticesOptions) SetSimilarDocumentIds(similarDocumentIds []string) *FederatedQueryNoticesOptions
- func (_options *FederatedQueryNoticesOptions) SetSimilarFields(similarFields []string) *FederatedQueryNoticesOptions
- func (_options *FederatedQueryNoticesOptions) SetSort(sort []string) *FederatedQueryNoticesOptions
- type FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetAggregation(aggregation string) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetBias(bias string) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetCollectionIds(collectionIds string) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetCount(count int64) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetDeduplicate(deduplicate bool) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetDeduplicateField(deduplicateField string) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetEnvironmentID(environmentID string) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetFilter(filter string) *FederatedQueryOptions
- func (options *FederatedQueryOptions) SetHeaders(param map[string]string) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetHighlight(highlight bool) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetNaturalLanguageQuery(naturalLanguageQuery string) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetOffset(offset int64) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetPassages(passages bool) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetPassagesCharacters(passagesCharacters int64) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetPassagesCount(passagesCount int64) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetPassagesFields(passagesFields string) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetQuery(query string) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetReturn(returnVar string) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetSimilar(similar bool) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetSimilarDocumentIds(similarDocumentIds string) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetSimilarFields(similarFields string) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetSort(sort string) *FederatedQueryOptions
- func (_options *FederatedQueryOptions) SetXWatsonLoggingOptOut(xWatsonLoggingOptOut bool) *FederatedQueryOptions
- type Field
- type Filter
- type FontSetting
- type Gateway
- type GatewayDelete
- type GatewayList
- type GetAutocompletionOptions
- func (_options *GetAutocompletionOptions) SetCollectionID(collectionID string) *GetAutocompletionOptions
- func (_options *GetAutocompletionOptions) SetCount(count int64) *GetAutocompletionOptions
- func (_options *GetAutocompletionOptions) SetEnvironmentID(environmentID string) *GetAutocompletionOptions
- func (_options *GetAutocompletionOptions) SetField(field string) *GetAutocompletionOptions
- func (options *GetAutocompletionOptions) SetHeaders(param map[string]string) *GetAutocompletionOptions
- func (_options *GetAutocompletionOptions) SetPrefix(prefix string) *GetAutocompletionOptions
- type GetCollectionOptions
- type GetConfigurationOptions
- func (_options *GetConfigurationOptions) SetConfigurationID(configurationID string) *GetConfigurationOptions
- func (_options *GetConfigurationOptions) SetEnvironmentID(environmentID string) *GetConfigurationOptions
- func (options *GetConfigurationOptions) SetHeaders(param map[string]string) *GetConfigurationOptions
- type GetCredentialsOptions
- type GetDocumentStatusOptions
- func (_options *GetDocumentStatusOptions) SetCollectionID(collectionID string) *GetDocumentStatusOptions
- func (_options *GetDocumentStatusOptions) SetDocumentID(documentID string) *GetDocumentStatusOptions
- func (_options *GetDocumentStatusOptions) SetEnvironmentID(environmentID string) *GetDocumentStatusOptions
- func (options *GetDocumentStatusOptions) SetHeaders(param map[string]string) *GetDocumentStatusOptions
- type GetEnvironmentOptions
- type GetGatewayOptions
- type GetMetricsEventRateOptions
- func (_options *GetMetricsEventRateOptions) SetEndTime(endTime *strfmt.DateTime) *GetMetricsEventRateOptions
- func (options *GetMetricsEventRateOptions) SetHeaders(param map[string]string) *GetMetricsEventRateOptions
- func (_options *GetMetricsEventRateOptions) SetResultType(resultType string) *GetMetricsEventRateOptions
- func (_options *GetMetricsEventRateOptions) SetStartTime(startTime *strfmt.DateTime) *GetMetricsEventRateOptions
- type GetMetricsQueryEventOptions
- func (_options *GetMetricsQueryEventOptions) SetEndTime(endTime *strfmt.DateTime) *GetMetricsQueryEventOptions
- func (options *GetMetricsQueryEventOptions) SetHeaders(param map[string]string) *GetMetricsQueryEventOptions
- func (_options *GetMetricsQueryEventOptions) SetResultType(resultType string) *GetMetricsQueryEventOptions
- func (_options *GetMetricsQueryEventOptions) SetStartTime(startTime *strfmt.DateTime) *GetMetricsQueryEventOptions
- type GetMetricsQueryNoResultsOptions
- func (_options *GetMetricsQueryNoResultsOptions) SetEndTime(endTime *strfmt.DateTime) *GetMetricsQueryNoResultsOptions
- func (options *GetMetricsQueryNoResultsOptions) SetHeaders(param map[string]string) *GetMetricsQueryNoResultsOptions
- func (_options *GetMetricsQueryNoResultsOptions) SetResultType(resultType string) *GetMetricsQueryNoResultsOptions
- func (_options *GetMetricsQueryNoResultsOptions) SetStartTime(startTime *strfmt.DateTime) *GetMetricsQueryNoResultsOptions
- type GetMetricsQueryOptions
- func (_options *GetMetricsQueryOptions) SetEndTime(endTime *strfmt.DateTime) *GetMetricsQueryOptions
- func (options *GetMetricsQueryOptions) SetHeaders(param map[string]string) *GetMetricsQueryOptions
- func (_options *GetMetricsQueryOptions) SetResultType(resultType string) *GetMetricsQueryOptions
- func (_options *GetMetricsQueryOptions) SetStartTime(startTime *strfmt.DateTime) *GetMetricsQueryOptions
- type GetMetricsQueryTokenEventOptions
- type GetStopwordListStatusOptions
- func (_options *GetStopwordListStatusOptions) SetCollectionID(collectionID string) *GetStopwordListStatusOptions
- func (_options *GetStopwordListStatusOptions) SetEnvironmentID(environmentID string) *GetStopwordListStatusOptions
- func (options *GetStopwordListStatusOptions) SetHeaders(param map[string]string) *GetStopwordListStatusOptions
- type GetTokenizationDictionaryStatusOptions
- func (_options *GetTokenizationDictionaryStatusOptions) SetCollectionID(collectionID string) *GetTokenizationDictionaryStatusOptions
- func (_options *GetTokenizationDictionaryStatusOptions) SetEnvironmentID(environmentID string) *GetTokenizationDictionaryStatusOptions
- func (options *GetTokenizationDictionaryStatusOptions) SetHeaders(param map[string]string) *GetTokenizationDictionaryStatusOptions
- type GetTrainingDataOptions
- func (_options *GetTrainingDataOptions) SetCollectionID(collectionID string) *GetTrainingDataOptions
- func (_options *GetTrainingDataOptions) SetEnvironmentID(environmentID string) *GetTrainingDataOptions
- func (options *GetTrainingDataOptions) SetHeaders(param map[string]string) *GetTrainingDataOptions
- func (_options *GetTrainingDataOptions) SetQueryID(queryID string) *GetTrainingDataOptions
- type GetTrainingExampleOptions
- func (_options *GetTrainingExampleOptions) SetCollectionID(collectionID string) *GetTrainingExampleOptions
- func (_options *GetTrainingExampleOptions) SetEnvironmentID(environmentID string) *GetTrainingExampleOptions
- func (_options *GetTrainingExampleOptions) SetExampleID(exampleID string) *GetTrainingExampleOptions
- func (options *GetTrainingExampleOptions) SetHeaders(param map[string]string) *GetTrainingExampleOptions
- func (_options *GetTrainingExampleOptions) SetQueryID(queryID string) *GetTrainingExampleOptions
- type HTMLSettings
- type Histogram
- type IndexCapacity
- type ListCollectionFieldsOptions
- func (_options *ListCollectionFieldsOptions) SetCollectionID(collectionID string) *ListCollectionFieldsOptions
- func (_options *ListCollectionFieldsOptions) SetEnvironmentID(environmentID string) *ListCollectionFieldsOptions
- func (options *ListCollectionFieldsOptions) SetHeaders(param map[string]string) *ListCollectionFieldsOptions
- type ListCollectionFieldsResponse
- type ListCollectionsOptions
- type ListCollectionsResponse
- type ListConfigurationsOptions
- func (_options *ListConfigurationsOptions) SetEnvironmentID(environmentID string) *ListConfigurationsOptions
- func (options *ListConfigurationsOptions) SetHeaders(param map[string]string) *ListConfigurationsOptions
- func (_options *ListConfigurationsOptions) SetName(name string) *ListConfigurationsOptions
- type ListConfigurationsResponse
- type ListCredentialsOptions
- type ListEnvironmentsOptions
- type ListEnvironmentsResponse
- type ListExpansionsOptions
- type ListFieldsOptions
- type ListGatewaysOptions
- type ListTrainingDataOptions
- func (_options *ListTrainingDataOptions) SetCollectionID(collectionID string) *ListTrainingDataOptions
- func (_options *ListTrainingDataOptions) SetEnvironmentID(environmentID string) *ListTrainingDataOptions
- func (options *ListTrainingDataOptions) SetHeaders(param map[string]string) *ListTrainingDataOptions
- type ListTrainingExamplesOptions
- func (_options *ListTrainingExamplesOptions) SetCollectionID(collectionID string) *ListTrainingExamplesOptions
- func (_options *ListTrainingExamplesOptions) SetEnvironmentID(environmentID string) *ListTrainingExamplesOptions
- func (options *ListTrainingExamplesOptions) SetHeaders(param map[string]string) *ListTrainingExamplesOptions
- func (_options *ListTrainingExamplesOptions) SetQueryID(queryID string) *ListTrainingExamplesOptions
- type LogQueryResponse
- type LogQueryResponseResult
- type LogQueryResponseResultDocuments
- type LogQueryResponseResultDocumentsResult
- type MetricAggregation
- type MetricAggregationResult
- type MetricResponse
- type MetricTokenAggregation
- type MetricTokenAggregationResult
- type MetricTokenResponse
- type Nested
- type NluEnrichmentConcepts
- type NluEnrichmentEmotion
- type NluEnrichmentEntities
- type NluEnrichmentFeatures
- type NluEnrichmentKeywords
- type NluEnrichmentRelations
- type NluEnrichmentSemanticRoles
- type NluEnrichmentSentiment
- type NormalizationOperation
- type Notice
- type PDFHeadingDetection
- type PDFSettings
- type QueryAggregation
- type QueryAggregationIntf
- type QueryLogOptions
- func (_options *QueryLogOptions) SetCount(count int64) *QueryLogOptions
- func (_options *QueryLogOptions) SetFilter(filter string) *QueryLogOptions
- func (options *QueryLogOptions) SetHeaders(param map[string]string) *QueryLogOptions
- func (_options *QueryLogOptions) SetOffset(offset int64) *QueryLogOptions
- func (_options *QueryLogOptions) SetQuery(query string) *QueryLogOptions
- func (_options *QueryLogOptions) SetSort(sort []string) *QueryLogOptions
- type QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetAggregation(aggregation string) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetCollectionID(collectionID string) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetCount(count int64) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetDeduplicateField(deduplicateField string) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetEnvironmentID(environmentID string) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetFilter(filter string) *QueryNoticesOptions
- func (options *QueryNoticesOptions) SetHeaders(param map[string]string) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetHighlight(highlight bool) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetNaturalLanguageQuery(naturalLanguageQuery string) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetOffset(offset int64) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetPassages(passages bool) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetPassagesCharacters(passagesCharacters int64) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetPassagesCount(passagesCount int64) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetPassagesFields(passagesFields []string) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetQuery(query string) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetReturn(returnVar []string) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetSimilar(similar bool) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetSimilarDocumentIds(similarDocumentIds []string) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetSimilarFields(similarFields []string) *QueryNoticesOptions
- func (_options *QueryNoticesOptions) SetSort(sort []string) *QueryNoticesOptions
- type QueryNoticesResponse
- type QueryNoticesResult
- func (o *QueryNoticesResult) GetProperties() map[string]interface{}
- func (o *QueryNoticesResult) GetProperty(key string) interface{}
- func (o *QueryNoticesResult) MarshalJSON() (buffer []byte, err error)
- func (o *QueryNoticesResult) SetProperties(m map[string]interface{})
- func (o *QueryNoticesResult) SetProperty(key string, value interface{})
- type QueryOptions
- func (_options *QueryOptions) SetAggregation(aggregation string) *QueryOptions
- func (_options *QueryOptions) SetBias(bias string) *QueryOptions
- func (_options *QueryOptions) SetCollectionID(collectionID string) *QueryOptions
- func (_options *QueryOptions) SetCount(count int64) *QueryOptions
- func (_options *QueryOptions) SetDeduplicate(deduplicate bool) *QueryOptions
- func (_options *QueryOptions) SetDeduplicateField(deduplicateField string) *QueryOptions
- func (_options *QueryOptions) SetEnvironmentID(environmentID string) *QueryOptions
- func (_options *QueryOptions) SetFilter(filter string) *QueryOptions
- func (options *QueryOptions) SetHeaders(param map[string]string) *QueryOptions
- func (_options *QueryOptions) SetHighlight(highlight bool) *QueryOptions
- func (_options *QueryOptions) SetNaturalLanguageQuery(naturalLanguageQuery string) *QueryOptions
- func (_options *QueryOptions) SetOffset(offset int64) *QueryOptions
- func (_options *QueryOptions) SetPassages(passages bool) *QueryOptions
- func (_options *QueryOptions) SetPassagesCharacters(passagesCharacters int64) *QueryOptions
- func (_options *QueryOptions) SetPassagesCount(passagesCount int64) *QueryOptions
- func (_options *QueryOptions) SetPassagesFields(passagesFields string) *QueryOptions
- func (_options *QueryOptions) SetQuery(query string) *QueryOptions
- func (_options *QueryOptions) SetReturn(returnVar string) *QueryOptions
- func (_options *QueryOptions) SetSimilar(similar bool) *QueryOptions
- func (_options *QueryOptions) SetSimilarDocumentIds(similarDocumentIds string) *QueryOptions
- func (_options *QueryOptions) SetSimilarFields(similarFields string) *QueryOptions
- func (_options *QueryOptions) SetSort(sort string) *QueryOptions
- func (_options *QueryOptions) SetSpellingSuggestions(spellingSuggestions bool) *QueryOptions
- func (_options *QueryOptions) SetXWatsonLoggingOptOut(xWatsonLoggingOptOut bool) *QueryOptions
- type QueryPassages
- type QueryResponse
- type QueryResult
- func (o *QueryResult) GetProperties() map[string]interface{}
- func (o *QueryResult) GetProperty(key string) interface{}
- func (o *QueryResult) MarshalJSON() (buffer []byte, err error)
- func (o *QueryResult) SetProperties(m map[string]interface{})
- func (o *QueryResult) SetProperty(key string, value interface{})
- type QueryResultMetadata
- type RetrievalDetails
- type SduStatus
- type SduStatusCustomFields
- type SearchStatus
- type SegmentSettings
- type Source
- type SourceOptions
- type SourceOptionsBuckets
- type SourceOptionsFolder
- type SourceOptionsObject
- type SourceOptionsSiteColl
- type SourceOptionsWebCrawl
- type SourceSchedule
- type SourceStatus
- type StatusDetails
- type Term
- type Timeslice
- type TokenDictRule
- type TokenDictStatusResponse
- type TopHits
- type TopHitsResults
- type TrainingDataSet
- type TrainingExample
- type TrainingExampleList
- type TrainingQuery
- type TrainingStatus
- type UpdateCollectionOptions
- func (_options *UpdateCollectionOptions) SetCollectionID(collectionID string) *UpdateCollectionOptions
- func (_options *UpdateCollectionOptions) SetConfigurationID(configurationID string) *UpdateCollectionOptions
- func (_options *UpdateCollectionOptions) SetDescription(description string) *UpdateCollectionOptions
- func (_options *UpdateCollectionOptions) SetEnvironmentID(environmentID string) *UpdateCollectionOptions
- func (options *UpdateCollectionOptions) SetHeaders(param map[string]string) *UpdateCollectionOptions
- func (_options *UpdateCollectionOptions) SetName(name string) *UpdateCollectionOptions
- type UpdateConfigurationOptions
- func (_options *UpdateConfigurationOptions) SetConfigurationID(configurationID string) *UpdateConfigurationOptions
- func (_options *UpdateConfigurationOptions) SetConversions(conversions *Conversions) *UpdateConfigurationOptions
- func (_options *UpdateConfigurationOptions) SetDescription(description string) *UpdateConfigurationOptions
- func (_options *UpdateConfigurationOptions) SetEnrichments(enrichments []Enrichment) *UpdateConfigurationOptions
- func (_options *UpdateConfigurationOptions) SetEnvironmentID(environmentID string) *UpdateConfigurationOptions
- func (options *UpdateConfigurationOptions) SetHeaders(param map[string]string) *UpdateConfigurationOptions
- func (_options *UpdateConfigurationOptions) SetName(name string) *UpdateConfigurationOptions
- func (_options *UpdateConfigurationOptions) SetNormalizations(normalizations []NormalizationOperation) *UpdateConfigurationOptions
- func (_options *UpdateConfigurationOptions) SetSource(source *Source) *UpdateConfigurationOptions
- type UpdateCredentialsOptions
- func (_options *UpdateCredentialsOptions) SetCredentialDetails(credentialDetails *CredentialDetails) *UpdateCredentialsOptions
- func (_options *UpdateCredentialsOptions) SetCredentialID(credentialID string) *UpdateCredentialsOptions
- func (_options *UpdateCredentialsOptions) SetEnvironmentID(environmentID string) *UpdateCredentialsOptions
- func (options *UpdateCredentialsOptions) SetHeaders(param map[string]string) *UpdateCredentialsOptions
- func (_options *UpdateCredentialsOptions) SetSourceType(sourceType string) *UpdateCredentialsOptions
- func (_options *UpdateCredentialsOptions) SetStatus(status *StatusDetails) *UpdateCredentialsOptions
- type UpdateDocumentOptions
- func (_options *UpdateDocumentOptions) SetCollectionID(collectionID string) *UpdateDocumentOptions
- func (_options *UpdateDocumentOptions) SetDocumentID(documentID string) *UpdateDocumentOptions
- func (_options *UpdateDocumentOptions) SetEnvironmentID(environmentID string) *UpdateDocumentOptions
- func (_options *UpdateDocumentOptions) SetFile(file io.ReadCloser) *UpdateDocumentOptions
- func (_options *UpdateDocumentOptions) SetFileContentType(fileContentType string) *UpdateDocumentOptions
- func (_options *UpdateDocumentOptions) SetFilename(filename string) *UpdateDocumentOptions
- func (options *UpdateDocumentOptions) SetHeaders(param map[string]string) *UpdateDocumentOptions
- func (_options *UpdateDocumentOptions) SetMetadata(metadata string) *UpdateDocumentOptions
- type UpdateEnvironmentOptions
- func (_options *UpdateEnvironmentOptions) SetDescription(description string) *UpdateEnvironmentOptions
- func (_options *UpdateEnvironmentOptions) SetEnvironmentID(environmentID string) *UpdateEnvironmentOptions
- func (options *UpdateEnvironmentOptions) SetHeaders(param map[string]string) *UpdateEnvironmentOptions
- func (_options *UpdateEnvironmentOptions) SetName(name string) *UpdateEnvironmentOptions
- func (_options *UpdateEnvironmentOptions) SetSize(size string) *UpdateEnvironmentOptions
- type UpdateTrainingExampleOptions
- func (_options *UpdateTrainingExampleOptions) SetCollectionID(collectionID string) *UpdateTrainingExampleOptions
- func (_options *UpdateTrainingExampleOptions) SetCrossReference(crossReference string) *UpdateTrainingExampleOptions
- func (_options *UpdateTrainingExampleOptions) SetEnvironmentID(environmentID string) *UpdateTrainingExampleOptions
- func (_options *UpdateTrainingExampleOptions) SetExampleID(exampleID string) *UpdateTrainingExampleOptions
- func (options *UpdateTrainingExampleOptions) SetHeaders(param map[string]string) *UpdateTrainingExampleOptions
- func (_options *UpdateTrainingExampleOptions) SetQueryID(queryID string) *UpdateTrainingExampleOptions
- func (_options *UpdateTrainingExampleOptions) SetRelevance(relevance int64) *UpdateTrainingExampleOptions
- type WordHeadingDetection
- type WordSettings
- type WordStyle
- type XPathPatterns
Constants ¶
const ( CollectionStatusActiveConst = "active" CollectionStatusMaintenanceConst = "maintenance" CollectionStatusPendingConst = "pending" )
Constants associated with the Collection.Status property. The status of the collection.
const ( CreateCollectionOptionsLanguageArConst = "ar" CreateCollectionOptionsLanguageDeConst = "de" CreateCollectionOptionsLanguageEnConst = "en" CreateCollectionOptionsLanguageEsConst = "es" CreateCollectionOptionsLanguageFrConst = "fr" CreateCollectionOptionsLanguageItConst = "it" CreateCollectionOptionsLanguageJaConst = "ja" CreateCollectionOptionsLanguageKoConst = "ko" CreateCollectionOptionsLanguageNlConst = "nl" CreateCollectionOptionsLanguagePtConst = "pt" CreateCollectionOptionsLanguageZhCnConst = "zh-CN" )
Constants associated with the CreateCollectionOptions.Language property. The language of the documents stored in the collection, in the form of an ISO 639-1 language code.
const ( CreateCredentialsOptionsSourceTypeBoxConst = "box" CreateCredentialsOptionsSourceTypeCloudObjectStorageConst = "cloud_object_storage" CreateCredentialsOptionsSourceTypeSalesforceConst = "salesforce" CreateCredentialsOptionsSourceTypeWebCrawlConst = "web_crawl" )
Constants associated with the CreateCredentialsOptions.SourceType property. The source that this credentials object connects to. - `box` indicates the credentials are used to connect an instance of Enterprise Box. - `salesforce` indicates the credentials are used to connect to Salesforce. - `sharepoint` indicates the credentials are used to connect to Microsoft SharePoint Online. - `web_crawl` indicates the credentials are used to perform a web crawl. = `cloud_object_storage` indicates the credentials are used to connect to an IBM Cloud Object Store.
const ( CreateEnvironmentOptionsSizeLConst = "L" CreateEnvironmentOptionsSizeLtConst = "LT" CreateEnvironmentOptionsSizeMConst = "M" CreateEnvironmentOptionsSizeMlConst = "ML" CreateEnvironmentOptionsSizeMsConst = "MS" CreateEnvironmentOptionsSizeSConst = "S" CreateEnvironmentOptionsSizeXlConst = "XL" CreateEnvironmentOptionsSizeXsConst = "XS" CreateEnvironmentOptionsSizeXxlConst = "XXL" CreateEnvironmentOptionsSizeXxxlConst = "XXXL" )
Constants associated with the CreateEnvironmentOptions.Size property. Size of the environment. In the Lite plan the default and only accepted value is `LT`, in all other plans the default is `S`.
const ( CredentialDetailsCredentialTypeAws4HmacConst = "aws4_hmac" CredentialDetailsCredentialTypeBasicConst = "basic" CredentialDetailsCredentialTypeNoauthConst = "noauth" CredentialDetailsCredentialTypeNtlmV1Const = "ntlm_v1" CredentialDetailsCredentialTypeOauth2Const = "oauth2" CredentialDetailsCredentialTypeSamlConst = "saml" CredentialDetailsCredentialTypeUsernamePasswordConst = "username_password" )
Constants associated with the CredentialDetails.CredentialType property. The authentication method for this credentials definition. The **credential_type** specified must be supported by the **source_type**. The following combinations are possible:
- `"source_type": "box"` - valid `credential_type`s: `oauth2` - `"source_type": "salesforce"` - valid `credential_type`s: `username_password` - `"source_type": "sharepoint"` - valid `credential_type`s: `saml` with **source_version** of `online`, or `ntlm_v1` with **source_version** of `2016` - `"source_type": "web_crawl"` - valid `credential_type`s: `noauth` or `basic` - "source_type": "cloud_object_storage"` - valid `credential_type`s: `aws4_hmac`.
const ( CredentialsSourceTypeBoxConst = "box" CredentialsSourceTypeCloudObjectStorageConst = "cloud_object_storage" CredentialsSourceTypeSalesforceConst = "salesforce" CredentialsSourceTypeWebCrawlConst = "web_crawl" )
Constants associated with the Credentials.SourceType property. The source that this credentials object connects to. - `box` indicates the credentials are used to connect an instance of Enterprise Box. - `salesforce` indicates the credentials are used to connect to Salesforce. - `sharepoint` indicates the credentials are used to connect to Microsoft SharePoint Online. - `web_crawl` indicates the credentials are used to perform a web crawl. = `cloud_object_storage` indicates the credentials are used to connect to an IBM Cloud Object Store.
const ( DocumentAcceptedStatusPendingConst = "pending" DocumentAcceptedStatusProcessingConst = "processing" )
Constants associated with the DocumentAccepted.Status property. Status of the document in the ingestion process. A status of `processing` is returned for documents that are ingested with a *version* date before `2019-01-01`. The `pending` status is returned for all others.
const ( DocumentStatusStatusAvailableConst = "available" DocumentStatusStatusAvailableWithNoticesConst = "available with notices" DocumentStatusStatusFailedConst = "failed" DocumentStatusStatusPendingConst = "pending" DocumentStatusStatusProcessingConst = "processing" )
Constants associated with the DocumentStatus.Status property. Status of the document in the ingestion process.
const ( DocumentStatusFileTypeHTMLConst = "html" DocumentStatusFileTypeJSONConst = "json" DocumentStatusFileTypePDFConst = "pdf" DocumentStatusFileTypeWordConst = "word" )
Constants associated with the DocumentStatus.FileType property. The type of the original source file.
const ( EnrichmentOptionsLanguageArConst = "ar" EnrichmentOptionsLanguageDeConst = "de" EnrichmentOptionsLanguageEnConst = "en" EnrichmentOptionsLanguageEsConst = "es" EnrichmentOptionsLanguageFrConst = "fr" EnrichmentOptionsLanguageItConst = "it" EnrichmentOptionsLanguagePtConst = "pt" EnrichmentOptionsLanguageRuConst = "ru" EnrichmentOptionsLanguageSvConst = "sv" )
Constants associated with the EnrichmentOptions.Language property. ISO 639-1 code indicating the language to use for the analysis. This code overrides the automatic language detection performed by the service. Valid codes are `ar` (Arabic), `en` (English), `fr` (French), `de` (German), `it` (Italian), `pt` (Portuguese), `ru` (Russian), `es` (Spanish), and `sv` (Swedish). **Note:** Not all features support all languages, automatic detection is recommended.
const ( EnvironmentStatusActiveConst = "active" EnvironmentStatusMaintenanceConst = "maintenance" EnvironmentStatusPendingConst = "pending" EnvironmentStatusResizingConst = "resizing" )
Constants associated with the Environment.Status property. Current status of the environment. `resizing` is displayed when a request to increase the environment size has been made, but is still in the process of being completed.
const ( EnvironmentSizeLConst = "L" EnvironmentSizeLtConst = "LT" EnvironmentSizeMConst = "M" EnvironmentSizeMlConst = "ML" EnvironmentSizeMsConst = "MS" EnvironmentSizeSConst = "S" EnvironmentSizeXlConst = "XL" EnvironmentSizeXsConst = "XS" EnvironmentSizeXxlConst = "XXL" EnvironmentSizeXxxlConst = "XXXL" )
Constants associated with the Environment.Size property. Current size of the environment.
const ( FieldTypeBinaryConst = "binary" FieldTypeBooleanConst = "boolean" FieldTypeByteConst = "byte" FieldTypeDateConst = "date" FieldTypeDoubleConst = "double" FieldTypeFloatConst = "float" FieldTypeIntegerConst = "integer" FieldTypeLongConst = "long" FieldTypeNestedConst = "nested" FieldTypeShortConst = "short" FieldTypeStringConst = "string" )
Constants associated with the Field.Type property. The type of the field.
const ( GatewayStatusConnectedConst = "connected" GatewayStatusIdleConst = "idle" )
Constants associated with the Gateway.Status property. The current status of the gateway. `connected` means the gateway is connected to the remotly installed gateway. `idle` means this gateway is not currently in use.
const ( LogQueryResponseResultDocumentTypeEventConst = "event" LogQueryResponseResultDocumentTypeQueryConst = "query" )
Constants associated with the LogQueryResponseResult.DocumentType property. The type of log entry returned.
**query** indicates that the log represents the results of a call to the single collection **query** method. **event** indicates that the log represents a call to the **events** API.
const ( LogQueryResponseResultEventTypeClickConst = "click" LogQueryResponseResultEventTypeQueryConst = "query" )
Constants associated with the LogQueryResponseResult.EventType property. The type of event that this object respresents. Possible values are
`query` the log of a query to a collection
`click` the result of a call to the **events** endpoint.
const ( NormalizationOperationOperationCopyConst = "copy" NormalizationOperationOperationMergeConst = "merge" NormalizationOperationOperationMoveConst = "move" NormalizationOperationOperationRemoveConst = "remove" NormalizationOperationOperationRemoveNullsConst = "remove_nulls" )
Constants associated with the NormalizationOperation.Operation property. Identifies what type of operation to perform.
**copy** - Copies the value of the **source_field** to the **destination_field** field. If the **destination_field** already exists, then the value of the **source_field** overwrites the original value of the **destination_field**.
**move** - Renames (moves) the **source_field** to the **destination_field**. If the **destination_field** already exists, then the value of the **source_field** overwrites the original value of the **destination_field**. Rename is identical to copy, except that the **source_field** is removed after the value has been copied to the **destination_field** (it is the same as a _copy_ followed by a _remove_).
**merge** - Merges the value of the **source_field** with the value of the **destination_field**. The **destination_field** is converted into an array if it is not already an array, and the value of the **source_field** is appended to the array. This operation removes the **source_field** after the merge. If the **source_field** does not exist in the current document, then the **destination_field** is still converted into an array (if it is not an array already). This conversion ensures the type for **destination_field** is consistent across all documents.
**remove** - Deletes the **source_field** field. The **destination_field** is ignored for this operation.
**remove_nulls** - Removes all nested null (blank) field values from the ingested document. **source_field** and **destination_field** are ignored by this operation because _remove_nulls_ operates on the entire ingested document. Typically, **remove_nulls** is invoked as the last normalization operation (if it is invoked at all, it can be time-expensive).
const ( NoticeSeverityErrorConst = "error" NoticeSeverityWarningConst = "warning" )
Constants associated with the Notice.Severity property. Severity level of the notice.
const ( QueryNoticesResultFileTypeHTMLConst = "html" QueryNoticesResultFileTypeJSONConst = "json" QueryNoticesResultFileTypePDFConst = "pdf" QueryNoticesResultFileTypeWordConst = "word" )
Constants associated with the QueryNoticesResult.FileType property. The type of the original source file.
const ( RetrievalDetailsDocumentRetrievalStrategyContinuousRelevancyTrainingConst = "continuous_relevancy_training" RetrievalDetailsDocumentRetrievalStrategyRelevancyTrainingConst = "relevancy_training" RetrievalDetailsDocumentRetrievalStrategyUntrainedConst = "untrained" )
Constants associated with the RetrievalDetails.DocumentRetrievalStrategy property. Indentifies the document retrieval strategy used for this query. `relevancy_training` indicates that the results were returned using a relevancy trained model. `continuous_relevancy_training` indicates that the results were returned using the continuous relevancy training model created by result feedback analysis. `untrained` means the results were returned using the standard untrained model.
**Note**: In the event of trained collections being queried, but the trained model is not used to return results,
the **document_retrieval_strategy** will be listed as `untrained`.
const ( SearchStatusStatusInsufficentDataConst = "INSUFFICENT_DATA" SearchStatusStatusNoDataConst = "NO_DATA" SearchStatusStatusNotApplicableConst = "NOT_APPLICABLE" SearchStatusStatusTrainedConst = "TRAINED" SearchStatusStatusTrainingConst = "TRAINING" )
Constants associated with the SearchStatus.Status property. The current status of Continuous Relevancy Training for this environment.
const ( SourceTypeBoxConst = "box" SourceTypeCloudObjectStorageConst = "cloud_object_storage" SourceTypeSalesforceConst = "salesforce" SourceTypeWebCrawlConst = "web_crawl" )
Constants associated with the Source.Type property. The type of source to connect to. - `box` indicates the configuration is to connect an instance of Enterprise Box. - `salesforce` indicates the configuration is to connect to Salesforce. - `sharepoint` indicates the configuration is to connect to Microsoft SharePoint Online. - `web_crawl` indicates the configuration is to perform a web page crawl. - `cloud_object_storage` indicates the configuration is to connect to a cloud object store.
const ( SourceOptionsWebCrawlCrawlSpeedAggressiveConst = "aggressive" SourceOptionsWebCrawlCrawlSpeedGentleConst = "gentle" SourceOptionsWebCrawlCrawlSpeedNormalConst = "normal" )
Constants associated with the SourceOptionsWebCrawl.CrawlSpeed property. The number of concurrent URLs to fetch. `gentle` means one URL is fetched at a time with a delay between each call. `normal` means as many as two URLs are fectched concurrently with a short delay between fetch calls. `aggressive` means that up to ten URLs are fetched concurrently with a short delay between fetch calls.
const ( SourceScheduleFrequencyDailyConst = "daily" SourceScheduleFrequencyFiveMinutesConst = "five_minutes" SourceScheduleFrequencyHourlyConst = "hourly" SourceScheduleFrequencyMonthlyConst = "monthly" SourceScheduleFrequencyWeeklyConst = "weekly" )
Constants associated with the SourceSchedule.Frequency property. The crawl schedule in the specified **time_zone**.
- `five_minutes`: Runs every five minutes. - `hourly`: Runs every hour. - `daily`: Runs every day between 00:00 and 06:00. - `weekly`: Runs every week on Sunday between 00:00 and 06:00. - `monthly`: Runs the on the first Sunday of every month between 00:00 and 06:00.
const ( SourceStatusStatusCompleteConst = "complete" SourceStatusStatusNotConfiguredConst = "not_configured" SourceStatusStatusQueuedConst = "queued" SourceStatusStatusRunningConst = "running" SourceStatusStatusUnknownConst = "unknown" )
Constants associated with the SourceStatus.Status property. The current status of the source crawl for this collection. This field returns `not_configured` if the default configuration for this source does not have a **source** object defined.
- `running` indicates that a crawl to fetch more documents is in progress. - `complete` indicates that the crawl has completed with no errors. - `queued` indicates that the crawl has been paused by the system and will automatically restart when possible. - `unknown` indicates that an unidentified error has occured in the service.
const ( TokenDictStatusResponseStatusActiveConst = "active" TokenDictStatusResponseStatusNotFoundConst = "not found" TokenDictStatusResponseStatusPendingConst = "pending" )
Constants associated with the TokenDictStatusResponse.Status property. Current wordlist status for the specified collection.
const ( UpdateCredentialsOptionsSourceTypeBoxConst = "box" UpdateCredentialsOptionsSourceTypeCloudObjectStorageConst = "cloud_object_storage" UpdateCredentialsOptionsSourceTypeSalesforceConst = "salesforce" UpdateCredentialsOptionsSourceTypeWebCrawlConst = "web_crawl" )
Constants associated with the UpdateCredentialsOptions.SourceType property. The source that this credentials object connects to. - `box` indicates the credentials are used to connect an instance of Enterprise Box. - `salesforce` indicates the credentials are used to connect to Salesforce. - `sharepoint` indicates the credentials are used to connect to Microsoft SharePoint Online. - `web_crawl` indicates the credentials are used to perform a web crawl. = `cloud_object_storage` indicates the credentials are used to connect to an IBM Cloud Object Store.
const ( UpdateEnvironmentOptionsSizeLConst = "L" UpdateEnvironmentOptionsSizeMConst = "M" UpdateEnvironmentOptionsSizeMlConst = "ML" UpdateEnvironmentOptionsSizeMsConst = "MS" UpdateEnvironmentOptionsSizeSConst = "S" UpdateEnvironmentOptionsSizeXlConst = "XL" UpdateEnvironmentOptionsSizeXxlConst = "XXL" UpdateEnvironmentOptionsSizeXxxlConst = "XXXL" )
Constants associated with the UpdateEnvironmentOptions.Size property. Size that the environment should be increased to. Environment size cannot be modified when using a Lite plan. Environment size can only increased and not decreased.
const (
CreateEventOptionsTypeClickConst = "click"
)
Constants associated with the CreateEventOptions.Type property. The event type to be created.
const (
CreateEventResponseTypeClickConst = "click"
)
Constants associated with the CreateEventResponse.Type property. The event type that was created.
const (
CredentialDetailsSourceVersionOnlineConst = "online"
)
Constants associated with the CredentialDetails.SourceVersion property. The type of Sharepoint repository to connect to. Only valid, and required, with a **source_type** of `sharepoint`.
const DefaultServiceName = "discovery"
DefaultServiceName is the default key used to find external configuration information.
const DefaultServiceURL = "https://api.us-south.discovery.watson.cloud.ibm.com"
DefaultServiceURL is the default URL to make service requests to.
const (
DeleteCollectionResponseStatusDeletedConst = "deleted"
)
Constants associated with the DeleteCollectionResponse.Status property. The status of the collection. The status of a successful deletion operation is `deleted`.
const (
DeleteConfigurationResponseStatusDeletedConst = "deleted"
)
Constants associated with the DeleteConfigurationResponse.Status property. Status of the configuration. A deleted configuration has the status deleted.
const (
DeleteCredentialsStatusDeletedConst = "deleted"
)
Constants associated with the DeleteCredentials.Status property. The status of the deletion request.
const (
DeleteDocumentResponseStatusDeletedConst = "deleted"
)
Constants associated with the DeleteDocumentResponse.Status property. Status of the document. A deleted document has the status deleted.
const (
DeleteEnvironmentResponseStatusDeletedConst = "deleted"
)
Constants associated with the DeleteEnvironmentResponse.Status property. Status of the environment.
const (
GetMetricsEventRateOptionsResultTypeDocumentConst = "document"
)
Constants associated with the GetMetricsEventRateOptions.ResultType property. The type of result to consider when calculating the metric.
const (
GetMetricsQueryEventOptionsResultTypeDocumentConst = "document"
)
Constants associated with the GetMetricsQueryEventOptions.ResultType property. The type of result to consider when calculating the metric.
const (
GetMetricsQueryNoResultsOptionsResultTypeDocumentConst = "document"
)
Constants associated with the GetMetricsQueryNoResultsOptions.ResultType property. The type of result to consider when calculating the metric.
const (
GetMetricsQueryOptionsResultTypeDocumentConst = "document"
)
Constants associated with the GetMetricsQueryOptions.ResultType property. The type of result to consider when calculating the metric.
const (
LogQueryResponseResultResultTypeDocumentConst = "document"
)
Constants associated with the LogQueryResponseResult.ResultType property. The type of result that this **event** is associated with. Only returned with logs of type `event`.
Variables ¶
This section is empty.
Functions ¶
func GetServiceURLForRegion ¶
GetServiceURLForRegion returns the service URL to be used for the specified region
func UnmarshalAggregationResult ¶
func UnmarshalAggregationResult(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalAggregationResult unmarshals an instance of AggregationResult from the specified map of raw messages.
func UnmarshalCalculation ¶
func UnmarshalCalculation(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCalculation unmarshals an instance of Calculation from the specified map of raw messages.
func UnmarshalCollection ¶
func UnmarshalCollection(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCollection unmarshals an instance of Collection from the specified map of raw messages.
func UnmarshalCollectionCrawlStatus ¶
func UnmarshalCollectionCrawlStatus(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCollectionCrawlStatus unmarshals an instance of CollectionCrawlStatus from the specified map of raw messages.
func UnmarshalCollectionDiskUsage ¶
func UnmarshalCollectionDiskUsage(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCollectionDiskUsage unmarshals an instance of CollectionDiskUsage from the specified map of raw messages.
func UnmarshalCollectionUsage ¶
func UnmarshalCollectionUsage(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCollectionUsage unmarshals an instance of CollectionUsage from the specified map of raw messages.
func UnmarshalCompletions ¶
func UnmarshalCompletions(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCompletions unmarshals an instance of Completions from the specified map of raw messages.
func UnmarshalConfiguration ¶
func UnmarshalConfiguration(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalConfiguration unmarshals an instance of Configuration from the specified map of raw messages.
func UnmarshalConversions ¶
func UnmarshalConversions(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalConversions unmarshals an instance of Conversions from the specified map of raw messages.
func UnmarshalCreateEventResponse ¶
func UnmarshalCreateEventResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCreateEventResponse unmarshals an instance of CreateEventResponse from the specified map of raw messages.
func UnmarshalCredentialDetails ¶
func UnmarshalCredentialDetails(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCredentialDetails unmarshals an instance of CredentialDetails from the specified map of raw messages.
func UnmarshalCredentials ¶
func UnmarshalCredentials(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCredentials unmarshals an instance of Credentials from the specified map of raw messages.
func UnmarshalCredentialsList ¶
func UnmarshalCredentialsList(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCredentialsList unmarshals an instance of CredentialsList from the specified map of raw messages.
func UnmarshalDeleteCollectionResponse ¶
func UnmarshalDeleteCollectionResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDeleteCollectionResponse unmarshals an instance of DeleteCollectionResponse from the specified map of raw messages.
func UnmarshalDeleteConfigurationResponse ¶
func UnmarshalDeleteConfigurationResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDeleteConfigurationResponse unmarshals an instance of DeleteConfigurationResponse from the specified map of raw messages.
func UnmarshalDeleteCredentials ¶
func UnmarshalDeleteCredentials(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDeleteCredentials unmarshals an instance of DeleteCredentials from the specified map of raw messages.
func UnmarshalDeleteDocumentResponse ¶
func UnmarshalDeleteDocumentResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDeleteDocumentResponse unmarshals an instance of DeleteDocumentResponse from the specified map of raw messages.
func UnmarshalDeleteEnvironmentResponse ¶
func UnmarshalDeleteEnvironmentResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDeleteEnvironmentResponse unmarshals an instance of DeleteEnvironmentResponse from the specified map of raw messages.
func UnmarshalDiskUsage ¶
func UnmarshalDiskUsage(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDiskUsage unmarshals an instance of DiskUsage from the specified map of raw messages.
func UnmarshalDocumentAccepted ¶
func UnmarshalDocumentAccepted(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDocumentAccepted unmarshals an instance of DocumentAccepted from the specified map of raw messages.
func UnmarshalDocumentCounts ¶
func UnmarshalDocumentCounts(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDocumentCounts unmarshals an instance of DocumentCounts from the specified map of raw messages.
func UnmarshalDocumentStatus ¶
func UnmarshalDocumentStatus(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDocumentStatus unmarshals an instance of DocumentStatus from the specified map of raw messages.
func UnmarshalEnrichment ¶
func UnmarshalEnrichment(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalEnrichment unmarshals an instance of Enrichment from the specified map of raw messages.
func UnmarshalEnrichmentOptions ¶
func UnmarshalEnrichmentOptions(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalEnrichmentOptions unmarshals an instance of EnrichmentOptions from the specified map of raw messages.
func UnmarshalEnvironment ¶
func UnmarshalEnvironment(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalEnvironment unmarshals an instance of Environment from the specified map of raw messages.
func UnmarshalEnvironmentDocuments ¶
func UnmarshalEnvironmentDocuments(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalEnvironmentDocuments unmarshals an instance of EnvironmentDocuments from the specified map of raw messages.
func UnmarshalEventData ¶
func UnmarshalEventData(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalEventData unmarshals an instance of EventData from the specified map of raw messages.
func UnmarshalExpansion ¶
func UnmarshalExpansion(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalExpansion unmarshals an instance of Expansion from the specified map of raw messages.
func UnmarshalExpansions ¶
func UnmarshalExpansions(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalExpansions unmarshals an instance of Expansions from the specified map of raw messages.
func UnmarshalField ¶
func UnmarshalField(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalField unmarshals an instance of Field from the specified map of raw messages.
func UnmarshalFilter ¶
func UnmarshalFilter(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalFilter unmarshals an instance of Filter from the specified map of raw messages.
func UnmarshalFontSetting ¶
func UnmarshalFontSetting(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalFontSetting unmarshals an instance of FontSetting from the specified map of raw messages.
func UnmarshalGateway ¶
func UnmarshalGateway(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalGateway unmarshals an instance of Gateway from the specified map of raw messages.
func UnmarshalGatewayDelete ¶
func UnmarshalGatewayDelete(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalGatewayDelete unmarshals an instance of GatewayDelete from the specified map of raw messages.
func UnmarshalGatewayList ¶
func UnmarshalGatewayList(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalGatewayList unmarshals an instance of GatewayList from the specified map of raw messages.
func UnmarshalHTMLSettings ¶
func UnmarshalHTMLSettings(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalHTMLSettings unmarshals an instance of HTMLSettings from the specified map of raw messages.
func UnmarshalHistogram ¶
func UnmarshalHistogram(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalHistogram unmarshals an instance of Histogram from the specified map of raw messages.
func UnmarshalIndexCapacity ¶
func UnmarshalIndexCapacity(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalIndexCapacity unmarshals an instance of IndexCapacity from the specified map of raw messages.
func UnmarshalListCollectionFieldsResponse ¶
func UnmarshalListCollectionFieldsResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListCollectionFieldsResponse unmarshals an instance of ListCollectionFieldsResponse from the specified map of raw messages.
func UnmarshalListCollectionsResponse ¶
func UnmarshalListCollectionsResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListCollectionsResponse unmarshals an instance of ListCollectionsResponse from the specified map of raw messages.
func UnmarshalListConfigurationsResponse ¶
func UnmarshalListConfigurationsResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListConfigurationsResponse unmarshals an instance of ListConfigurationsResponse from the specified map of raw messages.
func UnmarshalListEnvironmentsResponse ¶
func UnmarshalListEnvironmentsResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListEnvironmentsResponse unmarshals an instance of ListEnvironmentsResponse from the specified map of raw messages.
func UnmarshalLogQueryResponse ¶
func UnmarshalLogQueryResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalLogQueryResponse unmarshals an instance of LogQueryResponse from the specified map of raw messages.
func UnmarshalLogQueryResponseResult ¶
func UnmarshalLogQueryResponseResult(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalLogQueryResponseResult unmarshals an instance of LogQueryResponseResult from the specified map of raw messages.
func UnmarshalLogQueryResponseResultDocuments ¶
func UnmarshalLogQueryResponseResultDocuments(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalLogQueryResponseResultDocuments unmarshals an instance of LogQueryResponseResultDocuments from the specified map of raw messages.
func UnmarshalLogQueryResponseResultDocumentsResult ¶
func UnmarshalLogQueryResponseResultDocumentsResult(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalLogQueryResponseResultDocumentsResult unmarshals an instance of LogQueryResponseResultDocumentsResult from the specified map of raw messages.
func UnmarshalMetricAggregation ¶
func UnmarshalMetricAggregation(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalMetricAggregation unmarshals an instance of MetricAggregation from the specified map of raw messages.
func UnmarshalMetricAggregationResult ¶
func UnmarshalMetricAggregationResult(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalMetricAggregationResult unmarshals an instance of MetricAggregationResult from the specified map of raw messages.
func UnmarshalMetricResponse ¶
func UnmarshalMetricResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalMetricResponse unmarshals an instance of MetricResponse from the specified map of raw messages.
func UnmarshalMetricTokenAggregation ¶
func UnmarshalMetricTokenAggregation(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalMetricTokenAggregation unmarshals an instance of MetricTokenAggregation from the specified map of raw messages.
func UnmarshalMetricTokenAggregationResult ¶
func UnmarshalMetricTokenAggregationResult(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalMetricTokenAggregationResult unmarshals an instance of MetricTokenAggregationResult from the specified map of raw messages.
func UnmarshalMetricTokenResponse ¶
func UnmarshalMetricTokenResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalMetricTokenResponse unmarshals an instance of MetricTokenResponse from the specified map of raw messages.
func UnmarshalNested ¶
func UnmarshalNested(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalNested unmarshals an instance of Nested from the specified map of raw messages.
func UnmarshalNluEnrichmentConcepts ¶
func UnmarshalNluEnrichmentConcepts(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalNluEnrichmentConcepts unmarshals an instance of NluEnrichmentConcepts from the specified map of raw messages.
func UnmarshalNluEnrichmentEmotion ¶
func UnmarshalNluEnrichmentEmotion(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalNluEnrichmentEmotion unmarshals an instance of NluEnrichmentEmotion from the specified map of raw messages.
func UnmarshalNluEnrichmentEntities ¶
func UnmarshalNluEnrichmentEntities(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalNluEnrichmentEntities unmarshals an instance of NluEnrichmentEntities from the specified map of raw messages.
func UnmarshalNluEnrichmentFeatures ¶
func UnmarshalNluEnrichmentFeatures(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalNluEnrichmentFeatures unmarshals an instance of NluEnrichmentFeatures from the specified map of raw messages.
func UnmarshalNluEnrichmentKeywords ¶
func UnmarshalNluEnrichmentKeywords(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalNluEnrichmentKeywords unmarshals an instance of NluEnrichmentKeywords from the specified map of raw messages.
func UnmarshalNluEnrichmentRelations ¶
func UnmarshalNluEnrichmentRelations(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalNluEnrichmentRelations unmarshals an instance of NluEnrichmentRelations from the specified map of raw messages.
func UnmarshalNluEnrichmentSemanticRoles ¶
func UnmarshalNluEnrichmentSemanticRoles(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalNluEnrichmentSemanticRoles unmarshals an instance of NluEnrichmentSemanticRoles from the specified map of raw messages.
func UnmarshalNluEnrichmentSentiment ¶
func UnmarshalNluEnrichmentSentiment(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalNluEnrichmentSentiment unmarshals an instance of NluEnrichmentSentiment from the specified map of raw messages.
func UnmarshalNormalizationOperation ¶
func UnmarshalNormalizationOperation(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalNormalizationOperation unmarshals an instance of NormalizationOperation from the specified map of raw messages.
func UnmarshalNotice ¶
func UnmarshalNotice(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalNotice unmarshals an instance of Notice from the specified map of raw messages.
func UnmarshalPDFHeadingDetection ¶
func UnmarshalPDFHeadingDetection(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPDFHeadingDetection unmarshals an instance of PDFHeadingDetection from the specified map of raw messages.
func UnmarshalPDFSettings ¶
func UnmarshalPDFSettings(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalPDFSettings unmarshals an instance of PDFSettings from the specified map of raw messages.
func UnmarshalQueryAggregation ¶
func UnmarshalQueryAggregation(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalQueryAggregation unmarshals an instance of QueryAggregation from the specified map of raw messages.
func UnmarshalQueryNoticesResponse ¶
func UnmarshalQueryNoticesResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalQueryNoticesResponse unmarshals an instance of QueryNoticesResponse from the specified map of raw messages.
func UnmarshalQueryNoticesResult ¶
func UnmarshalQueryNoticesResult(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalQueryNoticesResult unmarshals an instance of QueryNoticesResult from the specified map of raw messages.
func UnmarshalQueryPassages ¶
func UnmarshalQueryPassages(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalQueryPassages unmarshals an instance of QueryPassages from the specified map of raw messages.
func UnmarshalQueryResponse ¶
func UnmarshalQueryResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalQueryResponse unmarshals an instance of QueryResponse from the specified map of raw messages.
func UnmarshalQueryResult ¶
func UnmarshalQueryResult(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalQueryResult unmarshals an instance of QueryResult from the specified map of raw messages.
func UnmarshalQueryResultMetadata ¶
func UnmarshalQueryResultMetadata(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalQueryResultMetadata unmarshals an instance of QueryResultMetadata from the specified map of raw messages.
func UnmarshalRetrievalDetails ¶
func UnmarshalRetrievalDetails(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalRetrievalDetails unmarshals an instance of RetrievalDetails from the specified map of raw messages.
func UnmarshalSduStatus ¶
func UnmarshalSduStatus(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSduStatus unmarshals an instance of SduStatus from the specified map of raw messages.
func UnmarshalSduStatusCustomFields ¶
func UnmarshalSduStatusCustomFields(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSduStatusCustomFields unmarshals an instance of SduStatusCustomFields from the specified map of raw messages.
func UnmarshalSearchStatus ¶
func UnmarshalSearchStatus(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSearchStatus unmarshals an instance of SearchStatus from the specified map of raw messages.
func UnmarshalSegmentSettings ¶
func UnmarshalSegmentSettings(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSegmentSettings unmarshals an instance of SegmentSettings from the specified map of raw messages.
func UnmarshalSource ¶
func UnmarshalSource(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSource unmarshals an instance of Source from the specified map of raw messages.
func UnmarshalSourceOptions ¶
func UnmarshalSourceOptions(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSourceOptions unmarshals an instance of SourceOptions from the specified map of raw messages.
func UnmarshalSourceOptionsBuckets ¶
func UnmarshalSourceOptionsBuckets(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSourceOptionsBuckets unmarshals an instance of SourceOptionsBuckets from the specified map of raw messages.
func UnmarshalSourceOptionsFolder ¶
func UnmarshalSourceOptionsFolder(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSourceOptionsFolder unmarshals an instance of SourceOptionsFolder from the specified map of raw messages.
func UnmarshalSourceOptionsObject ¶
func UnmarshalSourceOptionsObject(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSourceOptionsObject unmarshals an instance of SourceOptionsObject from the specified map of raw messages.
func UnmarshalSourceOptionsSiteColl ¶
func UnmarshalSourceOptionsSiteColl(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSourceOptionsSiteColl unmarshals an instance of SourceOptionsSiteColl from the specified map of raw messages.
func UnmarshalSourceOptionsWebCrawl ¶
func UnmarshalSourceOptionsWebCrawl(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSourceOptionsWebCrawl unmarshals an instance of SourceOptionsWebCrawl from the specified map of raw messages.
func UnmarshalSourceSchedule ¶
func UnmarshalSourceSchedule(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSourceSchedule unmarshals an instance of SourceSchedule from the specified map of raw messages.
func UnmarshalSourceStatus ¶
func UnmarshalSourceStatus(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSourceStatus unmarshals an instance of SourceStatus from the specified map of raw messages.
func UnmarshalStatusDetails ¶ added in v2.2.0
func UnmarshalStatusDetails(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalStatusDetails unmarshals an instance of StatusDetails from the specified map of raw messages.
func UnmarshalTerm ¶
func UnmarshalTerm(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTerm unmarshals an instance of Term from the specified map of raw messages.
func UnmarshalTimeslice ¶
func UnmarshalTimeslice(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTimeslice unmarshals an instance of Timeslice from the specified map of raw messages.
func UnmarshalTokenDictRule ¶
func UnmarshalTokenDictRule(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTokenDictRule unmarshals an instance of TokenDictRule from the specified map of raw messages.
func UnmarshalTokenDictStatusResponse ¶
func UnmarshalTokenDictStatusResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTokenDictStatusResponse unmarshals an instance of TokenDictStatusResponse from the specified map of raw messages.
func UnmarshalTopHits ¶
func UnmarshalTopHits(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTopHits unmarshals an instance of TopHits from the specified map of raw messages.
func UnmarshalTopHitsResults ¶
func UnmarshalTopHitsResults(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTopHitsResults unmarshals an instance of TopHitsResults from the specified map of raw messages.
func UnmarshalTrainingDataSet ¶
func UnmarshalTrainingDataSet(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTrainingDataSet unmarshals an instance of TrainingDataSet from the specified map of raw messages.
func UnmarshalTrainingExample ¶
func UnmarshalTrainingExample(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTrainingExample unmarshals an instance of TrainingExample from the specified map of raw messages.
func UnmarshalTrainingExampleList ¶
func UnmarshalTrainingExampleList(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTrainingExampleList unmarshals an instance of TrainingExampleList from the specified map of raw messages.
func UnmarshalTrainingQuery ¶
func UnmarshalTrainingQuery(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTrainingQuery unmarshals an instance of TrainingQuery from the specified map of raw messages.
func UnmarshalTrainingStatus ¶
func UnmarshalTrainingStatus(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTrainingStatus unmarshals an instance of TrainingStatus from the specified map of raw messages.
func UnmarshalWordHeadingDetection ¶
func UnmarshalWordHeadingDetection(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalWordHeadingDetection unmarshals an instance of WordHeadingDetection from the specified map of raw messages.
func UnmarshalWordSettings ¶
func UnmarshalWordSettings(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalWordSettings unmarshals an instance of WordSettings from the specified map of raw messages.
func UnmarshalWordStyle ¶
func UnmarshalWordStyle(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalWordStyle unmarshals an instance of WordStyle from the specified map of raw messages.
func UnmarshalXPathPatterns ¶
func UnmarshalXPathPatterns(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalXPathPatterns unmarshals an instance of XPathPatterns from the specified map of raw messages.
Types ¶
type AddDocumentOptions ¶
type AddDocumentOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // The content of the document to ingest. The maximum supported file size when adding a file to a collection is 50 // megabytes, the maximum supported file size when testing a configuration is 1 megabyte. Files larger than the // supported size are rejected. File io.ReadCloser `json:"-"` // The filename for file. Filename *string `json:"-"` // The content type of file. FileContentType *string `json:"-"` // The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: “` { // "Creator": "Johnny Appleseed", // "Subject": "Apples" // } “`. Metadata *string `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
AddDocumentOptions : The AddDocument options.
func (*AddDocumentOptions) SetCollectionID ¶
func (_options *AddDocumentOptions) SetCollectionID(collectionID string) *AddDocumentOptions
SetCollectionID : Allow user to set CollectionID
func (*AddDocumentOptions) SetEnvironmentID ¶
func (_options *AddDocumentOptions) SetEnvironmentID(environmentID string) *AddDocumentOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*AddDocumentOptions) SetFile ¶
func (_options *AddDocumentOptions) SetFile(file io.ReadCloser) *AddDocumentOptions
SetFile : Allow user to set File
func (*AddDocumentOptions) SetFileContentType ¶
func (_options *AddDocumentOptions) SetFileContentType(fileContentType string) *AddDocumentOptions
SetFileContentType : Allow user to set FileContentType
func (*AddDocumentOptions) SetFilename ¶
func (_options *AddDocumentOptions) SetFilename(filename string) *AddDocumentOptions
SetFilename : Allow user to set Filename
func (*AddDocumentOptions) SetHeaders ¶
func (options *AddDocumentOptions) SetHeaders(param map[string]string) *AddDocumentOptions
SetHeaders : Allow user to set Headers
func (*AddDocumentOptions) SetMetadata ¶
func (_options *AddDocumentOptions) SetMetadata(metadata string) *AddDocumentOptions
SetMetadata : Allow user to set Metadata
type AddTrainingDataOptions ¶
type AddTrainingDataOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // The natural text query for the new training query. NaturalLanguageQuery *string `json:"natural_language_query,omitempty"` // The filter used on the collection before the **natural_language_query** is applied. Filter *string `json:"filter,omitempty"` // Array of training examples. Examples []TrainingExample `json:"examples,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
AddTrainingDataOptions : The AddTrainingData options.
func (*AddTrainingDataOptions) SetCollectionID ¶
func (_options *AddTrainingDataOptions) SetCollectionID(collectionID string) *AddTrainingDataOptions
SetCollectionID : Allow user to set CollectionID
func (*AddTrainingDataOptions) SetEnvironmentID ¶
func (_options *AddTrainingDataOptions) SetEnvironmentID(environmentID string) *AddTrainingDataOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*AddTrainingDataOptions) SetExamples ¶
func (_options *AddTrainingDataOptions) SetExamples(examples []TrainingExample) *AddTrainingDataOptions
SetExamples : Allow user to set Examples
func (*AddTrainingDataOptions) SetFilter ¶
func (_options *AddTrainingDataOptions) SetFilter(filter string) *AddTrainingDataOptions
SetFilter : Allow user to set Filter
func (*AddTrainingDataOptions) SetHeaders ¶
func (options *AddTrainingDataOptions) SetHeaders(param map[string]string) *AddTrainingDataOptions
SetHeaders : Allow user to set Headers
func (*AddTrainingDataOptions) SetNaturalLanguageQuery ¶
func (_options *AddTrainingDataOptions) SetNaturalLanguageQuery(naturalLanguageQuery string) *AddTrainingDataOptions
SetNaturalLanguageQuery : Allow user to set NaturalLanguageQuery
type AggregationResult ¶
type AggregationResult struct { // Key that matched the aggregation type. Key *string `json:"key,omitempty"` // Number of matching results. MatchingResults *int64 `json:"matching_results,omitempty"` // Aggregations returned in the case of chained aggregations. Aggregations []QueryAggregationIntf `json:"aggregations,omitempty"` }
AggregationResult : Aggregation results for the specified query.
type Calculation ¶
type Calculation struct { // The type of aggregation command used. For example: term, filter, max, min, etc. Type *string `json:"type,omitempty"` // Array of aggregation results. Results []AggregationResult `json:"results,omitempty"` // Number of matching results. MatchingResults *int64 `json:"matching_results,omitempty"` // Aggregations returned by Discovery. Aggregations []QueryAggregationIntf `json:"aggregations,omitempty"` // The field where the aggregation is located in the document. Field *string `json:"field,omitempty"` // Value of the aggregation. Value *float64 `json:"value,omitempty"` }
Calculation : Calculation struct This model "extends" QueryAggregation
type Collection ¶
type Collection struct { // The unique identifier of the collection. CollectionID *string `json:"collection_id,omitempty"` // The name of the collection. Name *string `json:"name,omitempty"` // The description of the collection. Description *string `json:"description,omitempty"` // The creation date of the collection in the format yyyy-MM-dd'T'HH:mmcon:ss.SSS'Z'. Created *strfmt.DateTime `json:"created,omitempty"` // The timestamp of when the collection was last updated in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. Updated *strfmt.DateTime `json:"updated,omitempty"` // The status of the collection. Status *string `json:"status,omitempty"` // The unique identifier of the collection's configuration. ConfigurationID *string `json:"configuration_id,omitempty"` // The language of the documents stored in the collection. Permitted values include `en` (English), `de` (German), and // `es` (Spanish). Language *string `json:"language,omitempty"` // Object containing collection document count information. DocumentCounts *DocumentCounts `json:"document_counts,omitempty"` // Summary of the disk usage statistics for this collection. DiskUsage *CollectionDiskUsage `json:"disk_usage,omitempty"` // Training status details. TrainingStatus *TrainingStatus `json:"training_status,omitempty"` // Object containing information about the crawl status of this collection. CrawlStatus *CollectionCrawlStatus `json:"crawl_status,omitempty"` // Object containing smart document understanding information for this collection. SmartDocumentUnderstanding *SduStatus `json:"smart_document_understanding,omitempty"` }
Collection : A collection for storing documents.
type CollectionCrawlStatus ¶
type CollectionCrawlStatus struct { // Object containing source crawl status information. SourceCrawl *SourceStatus `json:"source_crawl,omitempty"` }
CollectionCrawlStatus : Object containing information about the crawl status of this collection.
type CollectionDiskUsage ¶
type CollectionDiskUsage struct { // Number of bytes used by the collection. UsedBytes *int64 `json:"used_bytes,omitempty"` }
CollectionDiskUsage : Summary of the disk usage statistics for this collection.
type CollectionUsage ¶
type CollectionUsage struct { // Number of active collections in the environment. Available *int64 `json:"available,omitempty"` // Total number of collections allowed in the environment. MaximumAllowed *int64 `json:"maximum_allowed,omitempty"` }
CollectionUsage : Summary of the collection usage in the environment.
type Completions ¶
type Completions struct { // Array of autcomplete suggestion based on the provided prefix. Completions []string `json:"completions,omitempty"` }
Completions : An object containing an array of autocompletion suggestions.
type Configuration ¶
type Configuration struct { // The unique identifier of the configuration. ConfigurationID *string `json:"configuration_id,omitempty"` // The name of the configuration. Name *string `json:"name" validate:"required"` // The creation date of the configuration in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. Created *strfmt.DateTime `json:"created,omitempty"` // The timestamp of when the configuration was last updated in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. Updated *strfmt.DateTime `json:"updated,omitempty"` // The description of the configuration, if available. Description *string `json:"description,omitempty"` // Document conversion settings. Conversions *Conversions `json:"conversions,omitempty"` // An array of document enrichment settings for the configuration. Enrichments []Enrichment `json:"enrichments,omitempty"` // Defines operations that can be used to transform the final output JSON into a normalized form. Operations are // executed in the order that they appear in the array. Normalizations []NormalizationOperation `json:"normalizations,omitempty"` // Object containing source parameters for the configuration. Source *Source `json:"source,omitempty"` }
Configuration : A custom configuration for the environment.
type Conversions ¶
type Conversions struct { // A list of PDF conversion settings. PDF *PDFSettings `json:"pdf,omitempty"` // A list of Word conversion settings. Word *WordSettings `json:"word,omitempty"` // A list of HTML conversion settings. HTML *HTMLSettings `json:"html,omitempty"` // A list of Document Segmentation settings. Segment *SegmentSettings `json:"segment,omitempty"` // Defines operations that can be used to transform the final output JSON into a normalized form. Operations are // executed in the order that they appear in the array. JSONNormalizations []NormalizationOperation `json:"json_normalizations,omitempty"` // When `true`, automatic text extraction from images (this includes images embedded in supported document formats, for // example PDF, and suppported image formats, for example TIFF) is performed on documents uploaded to the collection. // This field is supported on **Advanced** and higher plans only. **Lite** plans do not support image text recognition. ImageTextRecognition *bool `json:"image_text_recognition,omitempty"` }
Conversions : Document conversion settings.
type CreateCollectionOptions ¶
type CreateCollectionOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The name of the collection to be created. Name *string `json:"name" validate:"required"` // A description of the collection. Description *string `json:"description,omitempty"` // The ID of the configuration in which the collection is to be created. ConfigurationID *string `json:"configuration_id,omitempty"` // The language of the documents stored in the collection, in the form of an ISO 639-1 language code. Language *string `json:"language,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
CreateCollectionOptions : The CreateCollection options.
func (*CreateCollectionOptions) SetConfigurationID ¶
func (_options *CreateCollectionOptions) SetConfigurationID(configurationID string) *CreateCollectionOptions
SetConfigurationID : Allow user to set ConfigurationID
func (*CreateCollectionOptions) SetDescription ¶
func (_options *CreateCollectionOptions) SetDescription(description string) *CreateCollectionOptions
SetDescription : Allow user to set Description
func (*CreateCollectionOptions) SetEnvironmentID ¶
func (_options *CreateCollectionOptions) SetEnvironmentID(environmentID string) *CreateCollectionOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*CreateCollectionOptions) SetHeaders ¶
func (options *CreateCollectionOptions) SetHeaders(param map[string]string) *CreateCollectionOptions
SetHeaders : Allow user to set Headers
func (*CreateCollectionOptions) SetLanguage ¶
func (_options *CreateCollectionOptions) SetLanguage(language string) *CreateCollectionOptions
SetLanguage : Allow user to set Language
func (*CreateCollectionOptions) SetName ¶
func (_options *CreateCollectionOptions) SetName(name string) *CreateCollectionOptions
SetName : Allow user to set Name
type CreateConfigurationOptions ¶
type CreateConfigurationOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The name of the configuration. Name *string `json:"name" validate:"required"` // The description of the configuration, if available. Description *string `json:"description,omitempty"` // Document conversion settings. Conversions *Conversions `json:"conversions,omitempty"` // An array of document enrichment settings for the configuration. Enrichments []Enrichment `json:"enrichments,omitempty"` // Defines operations that can be used to transform the final output JSON into a normalized form. Operations are // executed in the order that they appear in the array. Normalizations []NormalizationOperation `json:"normalizations,omitempty"` // Object containing source parameters for the configuration. Source *Source `json:"source,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
CreateConfigurationOptions : The CreateConfiguration options.
func (*CreateConfigurationOptions) SetConversions ¶
func (_options *CreateConfigurationOptions) SetConversions(conversions *Conversions) *CreateConfigurationOptions
SetConversions : Allow user to set Conversions
func (*CreateConfigurationOptions) SetDescription ¶
func (_options *CreateConfigurationOptions) SetDescription(description string) *CreateConfigurationOptions
SetDescription : Allow user to set Description
func (*CreateConfigurationOptions) SetEnrichments ¶
func (_options *CreateConfigurationOptions) SetEnrichments(enrichments []Enrichment) *CreateConfigurationOptions
SetEnrichments : Allow user to set Enrichments
func (*CreateConfigurationOptions) SetEnvironmentID ¶
func (_options *CreateConfigurationOptions) SetEnvironmentID(environmentID string) *CreateConfigurationOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*CreateConfigurationOptions) SetHeaders ¶
func (options *CreateConfigurationOptions) SetHeaders(param map[string]string) *CreateConfigurationOptions
SetHeaders : Allow user to set Headers
func (*CreateConfigurationOptions) SetName ¶
func (_options *CreateConfigurationOptions) SetName(name string) *CreateConfigurationOptions
SetName : Allow user to set Name
func (*CreateConfigurationOptions) SetNormalizations ¶
func (_options *CreateConfigurationOptions) SetNormalizations(normalizations []NormalizationOperation) *CreateConfigurationOptions
SetNormalizations : Allow user to set Normalizations
func (*CreateConfigurationOptions) SetSource ¶
func (_options *CreateConfigurationOptions) SetSource(source *Source) *CreateConfigurationOptions
SetSource : Allow user to set Source
type CreateCredentialsOptions ¶
type CreateCredentialsOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The source that this credentials object connects to. // - `box` indicates the credentials are used to connect an instance of Enterprise Box. // - `salesforce` indicates the credentials are used to connect to Salesforce. // - `sharepoint` indicates the credentials are used to connect to Microsoft SharePoint Online. // - `web_crawl` indicates the credentials are used to perform a web crawl. // = `cloud_object_storage` indicates the credentials are used to connect to an IBM Cloud Object Store. SourceType *string `json:"source_type,omitempty"` // Object containing details of the stored credentials. // // Obtain credentials for your source from the administrator of the source. CredentialDetails *CredentialDetails `json:"credential_details,omitempty"` // Object that contains details about the status of the authentication process. Status *StatusDetails `json:"status,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
CreateCredentialsOptions : The CreateCredentials options.
func (*CreateCredentialsOptions) SetCredentialDetails ¶
func (_options *CreateCredentialsOptions) SetCredentialDetails(credentialDetails *CredentialDetails) *CreateCredentialsOptions
SetCredentialDetails : Allow user to set CredentialDetails
func (*CreateCredentialsOptions) SetEnvironmentID ¶
func (_options *CreateCredentialsOptions) SetEnvironmentID(environmentID string) *CreateCredentialsOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*CreateCredentialsOptions) SetHeaders ¶
func (options *CreateCredentialsOptions) SetHeaders(param map[string]string) *CreateCredentialsOptions
SetHeaders : Allow user to set Headers
func (*CreateCredentialsOptions) SetSourceType ¶
func (_options *CreateCredentialsOptions) SetSourceType(sourceType string) *CreateCredentialsOptions
SetSourceType : Allow user to set SourceType
func (*CreateCredentialsOptions) SetStatus ¶
func (_options *CreateCredentialsOptions) SetStatus(status *StatusDetails) *CreateCredentialsOptions
SetStatus : Allow user to set Status
type CreateEnvironmentOptions ¶
type CreateEnvironmentOptions struct { // Name that identifies the environment. Name *string `json:"name" validate:"required"` // Description of the environment. Description *string `json:"description,omitempty"` // Size of the environment. In the Lite plan the default and only accepted value is `LT`, in all other plans the // default is `S`. Size *string `json:"size,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
CreateEnvironmentOptions : The CreateEnvironment options.
func (*CreateEnvironmentOptions) SetDescription ¶
func (_options *CreateEnvironmentOptions) SetDescription(description string) *CreateEnvironmentOptions
SetDescription : Allow user to set Description
func (*CreateEnvironmentOptions) SetHeaders ¶
func (options *CreateEnvironmentOptions) SetHeaders(param map[string]string) *CreateEnvironmentOptions
SetHeaders : Allow user to set Headers
func (*CreateEnvironmentOptions) SetName ¶
func (_options *CreateEnvironmentOptions) SetName(name string) *CreateEnvironmentOptions
SetName : Allow user to set Name
func (*CreateEnvironmentOptions) SetSize ¶
func (_options *CreateEnvironmentOptions) SetSize(size string) *CreateEnvironmentOptions
SetSize : Allow user to set Size
type CreateEventOptions ¶
type CreateEventOptions struct { // The event type to be created. Type *string `json:"type" validate:"required"` // Query event data object. Data *EventData `json:"data" validate:"required"` // Allows users to set headers on API requests Headers map[string]string }
CreateEventOptions : The CreateEvent options.
func (*CreateEventOptions) SetData ¶
func (_options *CreateEventOptions) SetData(data *EventData) *CreateEventOptions
SetData : Allow user to set Data
func (*CreateEventOptions) SetHeaders ¶
func (options *CreateEventOptions) SetHeaders(param map[string]string) *CreateEventOptions
SetHeaders : Allow user to set Headers
func (*CreateEventOptions) SetType ¶
func (_options *CreateEventOptions) SetType(typeVar string) *CreateEventOptions
SetType : Allow user to set Type
type CreateEventResponse ¶
type CreateEventResponse struct { // The event type that was created. Type *string `json:"type,omitempty"` // Query event data object. Data *EventData `json:"data,omitempty"` }
CreateEventResponse : An object defining the event being created.
type CreateExpansionsOptions ¶
type CreateExpansionsOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // An array of query expansion definitions. // // Each object in the **expansions** array represents a term or set of terms that will be expanded into other terms. // Each expansion object can be configured as bidirectional or unidirectional. Bidirectional means that all terms are // expanded to all other terms in the object. Unidirectional means that a set list of terms can be expanded into a // second list of terms. // // To create a bi-directional expansion specify an **expanded_terms** array. When found in a query, all items in the // **expanded_terms** array are then expanded to the other items in the same array. // // To create a uni-directional expansion, specify both an array of **input_terms** and an array of **expanded_terms**. // When items in the **input_terms** array are present in a query, they are expanded using the items listed in the // **expanded_terms** array. Expansions []Expansion `json:"expansions" validate:"required"` // Allows users to set headers on API requests Headers map[string]string }
CreateExpansionsOptions : The CreateExpansions options.
func (*CreateExpansionsOptions) SetCollectionID ¶
func (_options *CreateExpansionsOptions) SetCollectionID(collectionID string) *CreateExpansionsOptions
SetCollectionID : Allow user to set CollectionID
func (*CreateExpansionsOptions) SetEnvironmentID ¶
func (_options *CreateExpansionsOptions) SetEnvironmentID(environmentID string) *CreateExpansionsOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*CreateExpansionsOptions) SetExpansions ¶
func (_options *CreateExpansionsOptions) SetExpansions(expansions []Expansion) *CreateExpansionsOptions
SetExpansions : Allow user to set Expansions
func (*CreateExpansionsOptions) SetHeaders ¶
func (options *CreateExpansionsOptions) SetHeaders(param map[string]string) *CreateExpansionsOptions
SetHeaders : Allow user to set Headers
type CreateGatewayOptions ¶
type CreateGatewayOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // User-defined name. Name *string `json:"name,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
CreateGatewayOptions : The CreateGateway options.
func (*CreateGatewayOptions) SetEnvironmentID ¶
func (_options *CreateGatewayOptions) SetEnvironmentID(environmentID string) *CreateGatewayOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*CreateGatewayOptions) SetHeaders ¶
func (options *CreateGatewayOptions) SetHeaders(param map[string]string) *CreateGatewayOptions
SetHeaders : Allow user to set Headers
func (*CreateGatewayOptions) SetName ¶
func (_options *CreateGatewayOptions) SetName(name string) *CreateGatewayOptions
SetName : Allow user to set Name
type CreateStopwordListOptions ¶
type CreateStopwordListOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // The content of the stopword list to ingest. StopwordFile io.ReadCloser `json:"-" validate:"required"` // The filename for stopwordFile. StopwordFilename *string `json:"-" validate:"required"` // Allows users to set headers on API requests Headers map[string]string }
CreateStopwordListOptions : The CreateStopwordList options.
func (*CreateStopwordListOptions) SetCollectionID ¶
func (_options *CreateStopwordListOptions) SetCollectionID(collectionID string) *CreateStopwordListOptions
SetCollectionID : Allow user to set CollectionID
func (*CreateStopwordListOptions) SetEnvironmentID ¶
func (_options *CreateStopwordListOptions) SetEnvironmentID(environmentID string) *CreateStopwordListOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*CreateStopwordListOptions) SetHeaders ¶
func (options *CreateStopwordListOptions) SetHeaders(param map[string]string) *CreateStopwordListOptions
SetHeaders : Allow user to set Headers
func (*CreateStopwordListOptions) SetStopwordFile ¶
func (_options *CreateStopwordListOptions) SetStopwordFile(stopwordFile io.ReadCloser) *CreateStopwordListOptions
SetStopwordFile : Allow user to set StopwordFile
func (*CreateStopwordListOptions) SetStopwordFilename ¶
func (_options *CreateStopwordListOptions) SetStopwordFilename(stopwordFilename string) *CreateStopwordListOptions
SetStopwordFilename : Allow user to set StopwordFilename
type CreateTokenizationDictionaryOptions ¶
type CreateTokenizationDictionaryOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // An array of tokenization rules. Each rule contains, the original `text` string, component `tokens`, any alternate // character set `readings`, and which `part_of_speech` the text is from. TokenizationRules []TokenDictRule `json:"tokenization_rules,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
CreateTokenizationDictionaryOptions : The CreateTokenizationDictionary options.
func (*CreateTokenizationDictionaryOptions) SetCollectionID ¶
func (_options *CreateTokenizationDictionaryOptions) SetCollectionID(collectionID string) *CreateTokenizationDictionaryOptions
SetCollectionID : Allow user to set CollectionID
func (*CreateTokenizationDictionaryOptions) SetEnvironmentID ¶
func (_options *CreateTokenizationDictionaryOptions) SetEnvironmentID(environmentID string) *CreateTokenizationDictionaryOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*CreateTokenizationDictionaryOptions) SetHeaders ¶
func (options *CreateTokenizationDictionaryOptions) SetHeaders(param map[string]string) *CreateTokenizationDictionaryOptions
SetHeaders : Allow user to set Headers
func (*CreateTokenizationDictionaryOptions) SetTokenizationRules ¶
func (_options *CreateTokenizationDictionaryOptions) SetTokenizationRules(tokenizationRules []TokenDictRule) *CreateTokenizationDictionaryOptions
SetTokenizationRules : Allow user to set TokenizationRules
type CreateTrainingExampleOptions ¶
type CreateTrainingExampleOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // The ID of the query used for training. QueryID *string `json:"-" validate:"required,ne="` // The document ID associated with this training example. DocumentID *string `json:"document_id,omitempty"` // The cross reference associated with this training example. CrossReference *string `json:"cross_reference,omitempty"` // The relevance of the training example. Relevance *int64 `json:"relevance,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
CreateTrainingExampleOptions : The CreateTrainingExample options.
func (*CreateTrainingExampleOptions) SetCollectionID ¶
func (_options *CreateTrainingExampleOptions) SetCollectionID(collectionID string) *CreateTrainingExampleOptions
SetCollectionID : Allow user to set CollectionID
func (*CreateTrainingExampleOptions) SetCrossReference ¶
func (_options *CreateTrainingExampleOptions) SetCrossReference(crossReference string) *CreateTrainingExampleOptions
SetCrossReference : Allow user to set CrossReference
func (*CreateTrainingExampleOptions) SetDocumentID ¶
func (_options *CreateTrainingExampleOptions) SetDocumentID(documentID string) *CreateTrainingExampleOptions
SetDocumentID : Allow user to set DocumentID
func (*CreateTrainingExampleOptions) SetEnvironmentID ¶
func (_options *CreateTrainingExampleOptions) SetEnvironmentID(environmentID string) *CreateTrainingExampleOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*CreateTrainingExampleOptions) SetHeaders ¶
func (options *CreateTrainingExampleOptions) SetHeaders(param map[string]string) *CreateTrainingExampleOptions
SetHeaders : Allow user to set Headers
func (*CreateTrainingExampleOptions) SetQueryID ¶
func (_options *CreateTrainingExampleOptions) SetQueryID(queryID string) *CreateTrainingExampleOptions
SetQueryID : Allow user to set QueryID
func (*CreateTrainingExampleOptions) SetRelevance ¶
func (_options *CreateTrainingExampleOptions) SetRelevance(relevance int64) *CreateTrainingExampleOptions
SetRelevance : Allow user to set Relevance
type CredentialDetails ¶
type CredentialDetails struct { // The authentication method for this credentials definition. The **credential_type** specified must be supported by // the **source_type**. The following combinations are possible: // // - `"source_type": "box"` - valid `credential_type`s: `oauth2` // - `"source_type": "salesforce"` - valid `credential_type`s: `username_password` // - `"source_type": "sharepoint"` - valid `credential_type`s: `saml` with **source_version** of `online`, or // `ntlm_v1` with **source_version** of `2016` // - `"source_type": "web_crawl"` - valid `credential_type`s: `noauth` or `basic` // - "source_type": "cloud_object_storage"` - valid `credential_type`s: `aws4_hmac`. CredentialType *string `json:"credential_type,omitempty"` // The **client_id** of the source that these credentials connect to. Only valid, and required, with a // **credential_type** of `oauth2`. ClientID *string `json:"client_id,omitempty"` // The **enterprise_id** of the Box site that these credentials connect to. Only valid, and required, with a // **source_type** of `box`. EnterpriseID *string `json:"enterprise_id,omitempty"` // The **url** of the source that these credentials connect to. Only valid, and required, with a **credential_type** of // `username_password`, `noauth`, and `basic`. URL *string `json:"url,omitempty"` // The **username** of the source that these credentials connect to. Only valid, and required, with a // **credential_type** of `saml`, `username_password`, `basic`, or `ntlm_v1`. Username *string `json:"username,omitempty"` // The **organization_url** of the source that these credentials connect to. Only valid, and required, with a // **credential_type** of `saml`. OrganizationURL *string `json:"organization_url,omitempty"` // The **site_collection.path** of the source that these credentials connect to. Only valid, and required, with a // **source_type** of `sharepoint`. SiteCollectionPath *string `json:"site_collection.path,omitempty"` // The **client_secret** of the source that these credentials connect to. Only valid, and required, with a // **credential_type** of `oauth2`. This value is never returned and is only used when creating or modifying // **credentials**. ClientSecret *string `json:"client_secret,omitempty"` // The **public_key_id** of the source that these credentials connect to. Only valid, and required, with a // **credential_type** of `oauth2`. This value is never returned and is only used when creating or modifying // **credentials**. PublicKeyID *string `json:"public_key_id,omitempty"` // The **private_key** of the source that these credentials connect to. Only valid, and required, with a // **credential_type** of `oauth2`. This value is never returned and is only used when creating or modifying // **credentials**. PrivateKey *string `json:"private_key,omitempty"` // The **passphrase** of the source that these credentials connect to. Only valid, and required, with a // **credential_type** of `oauth2`. This value is never returned and is only used when creating or modifying // **credentials**. Passphrase *string `json:"passphrase,omitempty"` // The **password** of the source that these credentials connect to. Only valid, and required, with // **credential_type**s of `saml`, `username_password`, `basic`, or `ntlm_v1`. // // **Note:** When used with a **source_type** of `salesforce`, the password consists of the Salesforce password and a // valid Salesforce security token concatenated. This value is never returned and is only used when creating or // modifying **credentials**. Password *string `json:"password,omitempty"` // The ID of the **gateway** to be connected through (when connecting to intranet sites). Only valid with a // **credential_type** of `noauth`, `basic`, or `ntlm_v1`. Gateways are created using the // `/v1/environments/{environment_id}/gateways` methods. GatewayID *string `json:"gateway_id,omitempty"` // The type of Sharepoint repository to connect to. Only valid, and required, with a **source_type** of `sharepoint`. SourceVersion *string `json:"source_version,omitempty"` // SharePoint OnPrem WebApplication URL. Only valid, and required, with a **source_version** of `2016`. If a port is // not supplied, the default to port `80` for http and port `443` for https connections are used. WebApplicationURL *string `json:"web_application_url,omitempty"` // The domain used to log in to your OnPrem SharePoint account. Only valid, and required, with a **source_version** of // `2016`. Domain *string `json:"domain,omitempty"` // The endpoint associated with the cloud object store that your are connecting to. Only valid, and required, with a // **credential_type** of `aws4_hmac`. Endpoint *string `json:"endpoint,omitempty"` // The access key ID associated with the cloud object store. Only valid, and required, with a **credential_type** of // `aws4_hmac`. This value is never returned and is only used when creating or modifying **credentials**. For more // infomation, see the [cloud object store // documentation](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-using-hmac-credentials#using-hmac-credentials). AccessKeyID *string `json:"access_key_id,omitempty"` // The secret access key associated with the cloud object store. Only valid, and required, with a **credential_type** // of `aws4_hmac`. This value is never returned and is only used when creating or modifying **credentials**. For more // infomation, see the [cloud object store // documentation](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-using-hmac-credentials#using-hmac-credentials). SecretAccessKey *string `json:"secret_access_key,omitempty"` }
CredentialDetails : Object containing details of the stored credentials.
Obtain credentials for your source from the administrator of the source.
type Credentials ¶
type Credentials struct { // Unique identifier for this set of credentials. CredentialID *string `json:"credential_id,omitempty"` // The source that this credentials object connects to. // - `box` indicates the credentials are used to connect an instance of Enterprise Box. // - `salesforce` indicates the credentials are used to connect to Salesforce. // - `sharepoint` indicates the credentials are used to connect to Microsoft SharePoint Online. // - `web_crawl` indicates the credentials are used to perform a web crawl. // = `cloud_object_storage` indicates the credentials are used to connect to an IBM Cloud Object Store. SourceType *string `json:"source_type,omitempty"` // Object containing details of the stored credentials. // // Obtain credentials for your source from the administrator of the source. CredentialDetails *CredentialDetails `json:"credential_details,omitempty"` // Object that contains details about the status of the authentication process. Status *StatusDetails `json:"status,omitempty"` }
Credentials : Object containing credential information.
type CredentialsList ¶
type CredentialsList struct { // An array of credential definitions that were created for this instance. Credentials []Credentials `json:"credentials,omitempty"` }
CredentialsList : Object containing array of credential definitions.
type DeleteAllTrainingDataOptions ¶
type DeleteAllTrainingDataOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteAllTrainingDataOptions : The DeleteAllTrainingData options.
func (*DeleteAllTrainingDataOptions) SetCollectionID ¶
func (_options *DeleteAllTrainingDataOptions) SetCollectionID(collectionID string) *DeleteAllTrainingDataOptions
SetCollectionID : Allow user to set CollectionID
func (*DeleteAllTrainingDataOptions) SetEnvironmentID ¶
func (_options *DeleteAllTrainingDataOptions) SetEnvironmentID(environmentID string) *DeleteAllTrainingDataOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*DeleteAllTrainingDataOptions) SetHeaders ¶
func (options *DeleteAllTrainingDataOptions) SetHeaders(param map[string]string) *DeleteAllTrainingDataOptions
SetHeaders : Allow user to set Headers
type DeleteCollectionOptions ¶
type DeleteCollectionOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteCollectionOptions : The DeleteCollection options.
func (*DeleteCollectionOptions) SetCollectionID ¶
func (_options *DeleteCollectionOptions) SetCollectionID(collectionID string) *DeleteCollectionOptions
SetCollectionID : Allow user to set CollectionID
func (*DeleteCollectionOptions) SetEnvironmentID ¶
func (_options *DeleteCollectionOptions) SetEnvironmentID(environmentID string) *DeleteCollectionOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*DeleteCollectionOptions) SetHeaders ¶
func (options *DeleteCollectionOptions) SetHeaders(param map[string]string) *DeleteCollectionOptions
SetHeaders : Allow user to set Headers
type DeleteCollectionResponse ¶
type DeleteCollectionResponse struct { // The unique identifier of the collection that is being deleted. CollectionID *string `json:"collection_id" validate:"required"` // The status of the collection. The status of a successful deletion operation is `deleted`. Status *string `json:"status" validate:"required"` }
DeleteCollectionResponse : Response object returned when deleting a colleciton.
type DeleteConfigurationOptions ¶
type DeleteConfigurationOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the configuration. ConfigurationID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteConfigurationOptions : The DeleteConfiguration options.
func (*DeleteConfigurationOptions) SetConfigurationID ¶
func (_options *DeleteConfigurationOptions) SetConfigurationID(configurationID string) *DeleteConfigurationOptions
SetConfigurationID : Allow user to set ConfigurationID
func (*DeleteConfigurationOptions) SetEnvironmentID ¶
func (_options *DeleteConfigurationOptions) SetEnvironmentID(environmentID string) *DeleteConfigurationOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*DeleteConfigurationOptions) SetHeaders ¶
func (options *DeleteConfigurationOptions) SetHeaders(param map[string]string) *DeleteConfigurationOptions
SetHeaders : Allow user to set Headers
type DeleteConfigurationResponse ¶
type DeleteConfigurationResponse struct { // The unique identifier for the configuration. ConfigurationID *string `json:"configuration_id" validate:"required"` // Status of the configuration. A deleted configuration has the status deleted. Status *string `json:"status" validate:"required"` // An array of notice messages, if any. Notices []Notice `json:"notices,omitempty"` }
DeleteConfigurationResponse : Information returned when a configuration is deleted.
type DeleteCredentials ¶
type DeleteCredentials struct { // The unique identifier of the credentials that have been deleted. CredentialID *string `json:"credential_id,omitempty"` // The status of the deletion request. Status *string `json:"status,omitempty"` }
DeleteCredentials : Object returned after credentials are deleted.
type DeleteCredentialsOptions ¶
type DeleteCredentialsOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The unique identifier for a set of source credentials. CredentialID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteCredentialsOptions : The DeleteCredentials options.
func (*DeleteCredentialsOptions) SetCredentialID ¶
func (_options *DeleteCredentialsOptions) SetCredentialID(credentialID string) *DeleteCredentialsOptions
SetCredentialID : Allow user to set CredentialID
func (*DeleteCredentialsOptions) SetEnvironmentID ¶
func (_options *DeleteCredentialsOptions) SetEnvironmentID(environmentID string) *DeleteCredentialsOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*DeleteCredentialsOptions) SetHeaders ¶
func (options *DeleteCredentialsOptions) SetHeaders(param map[string]string) *DeleteCredentialsOptions
SetHeaders : Allow user to set Headers
type DeleteDocumentOptions ¶
type DeleteDocumentOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // The ID of the document. DocumentID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteDocumentOptions : The DeleteDocument options.
func (*DeleteDocumentOptions) SetCollectionID ¶
func (_options *DeleteDocumentOptions) SetCollectionID(collectionID string) *DeleteDocumentOptions
SetCollectionID : Allow user to set CollectionID
func (*DeleteDocumentOptions) SetDocumentID ¶
func (_options *DeleteDocumentOptions) SetDocumentID(documentID string) *DeleteDocumentOptions
SetDocumentID : Allow user to set DocumentID
func (*DeleteDocumentOptions) SetEnvironmentID ¶
func (_options *DeleteDocumentOptions) SetEnvironmentID(environmentID string) *DeleteDocumentOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*DeleteDocumentOptions) SetHeaders ¶
func (options *DeleteDocumentOptions) SetHeaders(param map[string]string) *DeleteDocumentOptions
SetHeaders : Allow user to set Headers
type DeleteDocumentResponse ¶
type DeleteDocumentResponse struct { // The unique identifier of the document. DocumentID *string `json:"document_id,omitempty"` // Status of the document. A deleted document has the status deleted. Status *string `json:"status,omitempty"` }
DeleteDocumentResponse : Information returned when a document is deleted.
type DeleteEnvironmentOptions ¶
type DeleteEnvironmentOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteEnvironmentOptions : The DeleteEnvironment options.
func (*DeleteEnvironmentOptions) SetEnvironmentID ¶
func (_options *DeleteEnvironmentOptions) SetEnvironmentID(environmentID string) *DeleteEnvironmentOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*DeleteEnvironmentOptions) SetHeaders ¶
func (options *DeleteEnvironmentOptions) SetHeaders(param map[string]string) *DeleteEnvironmentOptions
SetHeaders : Allow user to set Headers
type DeleteEnvironmentResponse ¶
type DeleteEnvironmentResponse struct { // The unique identifier for the environment. EnvironmentID *string `json:"environment_id" validate:"required"` // Status of the environment. Status *string `json:"status" validate:"required"` }
DeleteEnvironmentResponse : Response object returned when deleting an environment.
type DeleteExpansionsOptions ¶
type DeleteExpansionsOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteExpansionsOptions : The DeleteExpansions options.
func (*DeleteExpansionsOptions) SetCollectionID ¶
func (_options *DeleteExpansionsOptions) SetCollectionID(collectionID string) *DeleteExpansionsOptions
SetCollectionID : Allow user to set CollectionID
func (*DeleteExpansionsOptions) SetEnvironmentID ¶
func (_options *DeleteExpansionsOptions) SetEnvironmentID(environmentID string) *DeleteExpansionsOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*DeleteExpansionsOptions) SetHeaders ¶
func (options *DeleteExpansionsOptions) SetHeaders(param map[string]string) *DeleteExpansionsOptions
SetHeaders : Allow user to set Headers
type DeleteGatewayOptions ¶
type DeleteGatewayOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The requested gateway ID. GatewayID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteGatewayOptions : The DeleteGateway options.
func (*DeleteGatewayOptions) SetEnvironmentID ¶
func (_options *DeleteGatewayOptions) SetEnvironmentID(environmentID string) *DeleteGatewayOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*DeleteGatewayOptions) SetGatewayID ¶
func (_options *DeleteGatewayOptions) SetGatewayID(gatewayID string) *DeleteGatewayOptions
SetGatewayID : Allow user to set GatewayID
func (*DeleteGatewayOptions) SetHeaders ¶
func (options *DeleteGatewayOptions) SetHeaders(param map[string]string) *DeleteGatewayOptions
SetHeaders : Allow user to set Headers
type DeleteStopwordListOptions ¶
type DeleteStopwordListOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteStopwordListOptions : The DeleteStopwordList options.
func (*DeleteStopwordListOptions) SetCollectionID ¶
func (_options *DeleteStopwordListOptions) SetCollectionID(collectionID string) *DeleteStopwordListOptions
SetCollectionID : Allow user to set CollectionID
func (*DeleteStopwordListOptions) SetEnvironmentID ¶
func (_options *DeleteStopwordListOptions) SetEnvironmentID(environmentID string) *DeleteStopwordListOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*DeleteStopwordListOptions) SetHeaders ¶
func (options *DeleteStopwordListOptions) SetHeaders(param map[string]string) *DeleteStopwordListOptions
SetHeaders : Allow user to set Headers
type DeleteTokenizationDictionaryOptions ¶
type DeleteTokenizationDictionaryOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteTokenizationDictionaryOptions : The DeleteTokenizationDictionary options.
func (*DeleteTokenizationDictionaryOptions) SetCollectionID ¶
func (_options *DeleteTokenizationDictionaryOptions) SetCollectionID(collectionID string) *DeleteTokenizationDictionaryOptions
SetCollectionID : Allow user to set CollectionID
func (*DeleteTokenizationDictionaryOptions) SetEnvironmentID ¶
func (_options *DeleteTokenizationDictionaryOptions) SetEnvironmentID(environmentID string) *DeleteTokenizationDictionaryOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*DeleteTokenizationDictionaryOptions) SetHeaders ¶
func (options *DeleteTokenizationDictionaryOptions) SetHeaders(param map[string]string) *DeleteTokenizationDictionaryOptions
SetHeaders : Allow user to set Headers
type DeleteTrainingDataOptions ¶
type DeleteTrainingDataOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // The ID of the query used for training. QueryID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteTrainingDataOptions : The DeleteTrainingData options.
func (*DeleteTrainingDataOptions) SetCollectionID ¶
func (_options *DeleteTrainingDataOptions) SetCollectionID(collectionID string) *DeleteTrainingDataOptions
SetCollectionID : Allow user to set CollectionID
func (*DeleteTrainingDataOptions) SetEnvironmentID ¶
func (_options *DeleteTrainingDataOptions) SetEnvironmentID(environmentID string) *DeleteTrainingDataOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*DeleteTrainingDataOptions) SetHeaders ¶
func (options *DeleteTrainingDataOptions) SetHeaders(param map[string]string) *DeleteTrainingDataOptions
SetHeaders : Allow user to set Headers
func (*DeleteTrainingDataOptions) SetQueryID ¶
func (_options *DeleteTrainingDataOptions) SetQueryID(queryID string) *DeleteTrainingDataOptions
SetQueryID : Allow user to set QueryID
type DeleteTrainingExampleOptions ¶
type DeleteTrainingExampleOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // The ID of the query used for training. QueryID *string `json:"-" validate:"required,ne="` // The ID of the document as it is indexed. ExampleID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteTrainingExampleOptions : The DeleteTrainingExample options.
func (*DeleteTrainingExampleOptions) SetCollectionID ¶
func (_options *DeleteTrainingExampleOptions) SetCollectionID(collectionID string) *DeleteTrainingExampleOptions
SetCollectionID : Allow user to set CollectionID
func (*DeleteTrainingExampleOptions) SetEnvironmentID ¶
func (_options *DeleteTrainingExampleOptions) SetEnvironmentID(environmentID string) *DeleteTrainingExampleOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*DeleteTrainingExampleOptions) SetExampleID ¶
func (_options *DeleteTrainingExampleOptions) SetExampleID(exampleID string) *DeleteTrainingExampleOptions
SetExampleID : Allow user to set ExampleID
func (*DeleteTrainingExampleOptions) SetHeaders ¶
func (options *DeleteTrainingExampleOptions) SetHeaders(param map[string]string) *DeleteTrainingExampleOptions
SetHeaders : Allow user to set Headers
func (*DeleteTrainingExampleOptions) SetQueryID ¶
func (_options *DeleteTrainingExampleOptions) SetQueryID(queryID string) *DeleteTrainingExampleOptions
SetQueryID : Allow user to set QueryID
type DeleteUserDataOptions ¶
type DeleteUserDataOptions struct { // The customer ID for which all data is to be deleted. CustomerID *string `json:"-" validate:"required"` // Allows users to set headers on API requests Headers map[string]string }
DeleteUserDataOptions : The DeleteUserData options.
func (*DeleteUserDataOptions) SetCustomerID ¶
func (_options *DeleteUserDataOptions) SetCustomerID(customerID string) *DeleteUserDataOptions
SetCustomerID : Allow user to set CustomerID
func (*DeleteUserDataOptions) SetHeaders ¶
func (options *DeleteUserDataOptions) SetHeaders(param map[string]string) *DeleteUserDataOptions
SetHeaders : Allow user to set Headers
type DiscoveryV1 ¶
type DiscoveryV1 struct { Service *core.BaseService // Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is // `2019-04-30`. Version *string }
DiscoveryV1 : IBM Watson™ Discovery is a cognitive search and content analytics engine that you can add to applications to identify patterns, trends and actionable insights to drive better decision-making. Securely unify structured and unstructured data with pre-enriched content, and use a simplified query language to eliminate the need for manual filtering of results.
API Version: 1.0 See: https://cloud.ibm.com/docs/discovery
func NewDiscoveryV1 ¶
func NewDiscoveryV1(options *DiscoveryV1Options) (service *DiscoveryV1, err error)
NewDiscoveryV1 : constructs an instance of DiscoveryV1 with passed in options.
func (*DiscoveryV1) AddDocument ¶
func (discovery *DiscoveryV1) AddDocument(addDocumentOptions *AddDocumentOptions) (result *DocumentAccepted, response *core.DetailedResponse, err error)
AddDocument : Add a document Add a document to a collection with optional metadata.
The **version** query parameter is still required.
Returns immediately after the system has accepted the document for processing.
The user must provide document content, metadata, or both. If the request is missing both document content and
metadata, it is rejected.
- The user can set the **Content-Type** parameter on the **file** part to indicate the media type of the document.
If the **Content-Type** parameter is missing or is one of the generic media types (for example, `application/octet-stream`), then the service attempts to automatically detect the document's media type.
- The following field names are reserved and will be filtered out if present after normalization: `id`, `score`,
`highlight`, and any field with the prefix of: `_`, `+`, or `-`
Fields with empty name values after normalization are filtered out before indexing.
Fields containing the following characters after normalization are filtered out before indexing: `#` and `,`
**Note:** Documents can be added with a specific **document_id** by using the
**_/v1/environments/{environment_id}/collections/{collection_id}/documents** method.
func (*DiscoveryV1) AddDocumentWithContext ¶
func (discovery *DiscoveryV1) AddDocumentWithContext(ctx context.Context, addDocumentOptions *AddDocumentOptions) (result *DocumentAccepted, response *core.DetailedResponse, err error)
AddDocumentWithContext is an alternate form of the AddDocument method which supports a Context parameter
func (*DiscoveryV1) AddTrainingData ¶
func (discovery *DiscoveryV1) AddTrainingData(addTrainingDataOptions *AddTrainingDataOptions) (result *TrainingQuery, response *core.DetailedResponse, err error)
AddTrainingData : Add query to training data Adds a query to the training data for this collection. The query can contain a filter and natural language query.
func (*DiscoveryV1) AddTrainingDataWithContext ¶
func (discovery *DiscoveryV1) AddTrainingDataWithContext(ctx context.Context, addTrainingDataOptions *AddTrainingDataOptions) (result *TrainingQuery, response *core.DetailedResponse, err error)
AddTrainingDataWithContext is an alternate form of the AddTrainingData method which supports a Context parameter
func (*DiscoveryV1) Clone ¶
func (discovery *DiscoveryV1) Clone() *DiscoveryV1
Clone makes a copy of "discovery" suitable for processing requests.
func (*DiscoveryV1) CreateCollection ¶
func (discovery *DiscoveryV1) CreateCollection(createCollectionOptions *CreateCollectionOptions) (result *Collection, response *core.DetailedResponse, err error)
CreateCollection : Create a collection
func (*DiscoveryV1) CreateCollectionWithContext ¶
func (discovery *DiscoveryV1) CreateCollectionWithContext(ctx context.Context, createCollectionOptions *CreateCollectionOptions) (result *Collection, response *core.DetailedResponse, err error)
CreateCollectionWithContext is an alternate form of the CreateCollection method which supports a Context parameter
func (*DiscoveryV1) CreateConfiguration ¶
func (discovery *DiscoveryV1) CreateConfiguration(createConfigurationOptions *CreateConfigurationOptions) (result *Configuration, response *core.DetailedResponse, err error)
CreateConfiguration : Add configuration Creates a new configuration.
If the input configuration contains the **configuration_id**, **created**, or **updated** properties, then they are ignored and overridden by the system, and an error is not returned so that the overridden fields do not need to be removed when copying a configuration.
The configuration can contain unrecognized JSON fields. Any such fields are ignored and do not generate an error. This makes it easier to use newer configuration files with older versions of the API and the service. It also makes it possible for the tooling to add additional metadata and information to the configuration.
func (*DiscoveryV1) CreateConfigurationWithContext ¶
func (discovery *DiscoveryV1) CreateConfigurationWithContext(ctx context.Context, createConfigurationOptions *CreateConfigurationOptions) (result *Configuration, response *core.DetailedResponse, err error)
CreateConfigurationWithContext is an alternate form of the CreateConfiguration method which supports a Context parameter
func (*DiscoveryV1) CreateCredentials ¶
func (discovery *DiscoveryV1) CreateCredentials(createCredentialsOptions *CreateCredentialsOptions) (result *Credentials, response *core.DetailedResponse, err error)
CreateCredentials : Create credentials Creates a set of credentials to connect to a remote source. Created credentials are used in a configuration to associate a collection with the remote source.
**Note:** All credentials are sent over an encrypted connection and encrypted at rest.
func (*DiscoveryV1) CreateCredentialsWithContext ¶
func (discovery *DiscoveryV1) CreateCredentialsWithContext(ctx context.Context, createCredentialsOptions *CreateCredentialsOptions) (result *Credentials, response *core.DetailedResponse, err error)
CreateCredentialsWithContext is an alternate form of the CreateCredentials method which supports a Context parameter
func (*DiscoveryV1) CreateEnvironment ¶
func (discovery *DiscoveryV1) CreateEnvironment(createEnvironmentOptions *CreateEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)
CreateEnvironment : Create an environment Creates a new environment for private data. An environment must be created before collections can be created.
**Note**: You can create only one environment for private data per service instance. An attempt to create another environment results in an error.
func (*DiscoveryV1) CreateEnvironmentWithContext ¶
func (discovery *DiscoveryV1) CreateEnvironmentWithContext(ctx context.Context, createEnvironmentOptions *CreateEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)
CreateEnvironmentWithContext is an alternate form of the CreateEnvironment method which supports a Context parameter
func (*DiscoveryV1) CreateEvent ¶
func (discovery *DiscoveryV1) CreateEvent(createEventOptions *CreateEventOptions) (result *CreateEventResponse, response *core.DetailedResponse, err error)
CreateEvent : Create event The **Events** API can be used to create log entries that are associated with specific queries. For example, you can record which documents in the results set were "clicked" by a user and when that click occurred.
func (*DiscoveryV1) CreateEventWithContext ¶
func (discovery *DiscoveryV1) CreateEventWithContext(ctx context.Context, createEventOptions *CreateEventOptions) (result *CreateEventResponse, response *core.DetailedResponse, err error)
CreateEventWithContext is an alternate form of the CreateEvent method which supports a Context parameter
func (*DiscoveryV1) CreateExpansions ¶
func (discovery *DiscoveryV1) CreateExpansions(createExpansionsOptions *CreateExpansionsOptions) (result *Expansions, response *core.DetailedResponse, err error)
CreateExpansions : Create or update expansion list Create or replace the Expansion list for this collection. The maximum number of expanded terms per collection is `500`. The current expansion list is replaced with the uploaded content.
func (*DiscoveryV1) CreateExpansionsWithContext ¶
func (discovery *DiscoveryV1) CreateExpansionsWithContext(ctx context.Context, createExpansionsOptions *CreateExpansionsOptions) (result *Expansions, response *core.DetailedResponse, err error)
CreateExpansionsWithContext is an alternate form of the CreateExpansions method which supports a Context parameter
func (*DiscoveryV1) CreateGateway ¶
func (discovery *DiscoveryV1) CreateGateway(createGatewayOptions *CreateGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)
CreateGateway : Create Gateway Create a gateway configuration to use with a remotely installed gateway.
func (*DiscoveryV1) CreateGatewayWithContext ¶
func (discovery *DiscoveryV1) CreateGatewayWithContext(ctx context.Context, createGatewayOptions *CreateGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)
CreateGatewayWithContext is an alternate form of the CreateGateway method which supports a Context parameter
func (*DiscoveryV1) CreateStopwordList ¶
func (discovery *DiscoveryV1) CreateStopwordList(createStopwordListOptions *CreateStopwordListOptions) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
CreateStopwordList : Create stopword list Upload a custom stopword list to use with the specified collection.
func (*DiscoveryV1) CreateStopwordListWithContext ¶
func (discovery *DiscoveryV1) CreateStopwordListWithContext(ctx context.Context, createStopwordListOptions *CreateStopwordListOptions) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
CreateStopwordListWithContext is an alternate form of the CreateStopwordList method which supports a Context parameter
func (*DiscoveryV1) CreateTokenizationDictionary ¶
func (discovery *DiscoveryV1) CreateTokenizationDictionary(createTokenizationDictionaryOptions *CreateTokenizationDictionaryOptions) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
CreateTokenizationDictionary : Create tokenization dictionary Upload a custom tokenization dictionary to use with the specified collection.
func (*DiscoveryV1) CreateTokenizationDictionaryWithContext ¶
func (discovery *DiscoveryV1) CreateTokenizationDictionaryWithContext(ctx context.Context, createTokenizationDictionaryOptions *CreateTokenizationDictionaryOptions) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
CreateTokenizationDictionaryWithContext is an alternate form of the CreateTokenizationDictionary method which supports a Context parameter
func (*DiscoveryV1) CreateTrainingExample ¶
func (discovery *DiscoveryV1) CreateTrainingExample(createTrainingExampleOptions *CreateTrainingExampleOptions) (result *TrainingExample, response *core.DetailedResponse, err error)
CreateTrainingExample : Add example to training data query Adds a example to this training data query.
func (*DiscoveryV1) CreateTrainingExampleWithContext ¶
func (discovery *DiscoveryV1) CreateTrainingExampleWithContext(ctx context.Context, createTrainingExampleOptions *CreateTrainingExampleOptions) (result *TrainingExample, response *core.DetailedResponse, err error)
CreateTrainingExampleWithContext is an alternate form of the CreateTrainingExample method which supports a Context parameter
func (*DiscoveryV1) DeleteAllTrainingData ¶
func (discovery *DiscoveryV1) DeleteAllTrainingData(deleteAllTrainingDataOptions *DeleteAllTrainingDataOptions) (response *core.DetailedResponse, err error)
DeleteAllTrainingData : Delete all training data Deletes all training data from a collection.
func (*DiscoveryV1) DeleteAllTrainingDataWithContext ¶
func (discovery *DiscoveryV1) DeleteAllTrainingDataWithContext(ctx context.Context, deleteAllTrainingDataOptions *DeleteAllTrainingDataOptions) (response *core.DetailedResponse, err error)
DeleteAllTrainingDataWithContext is an alternate form of the DeleteAllTrainingData method which supports a Context parameter
func (*DiscoveryV1) DeleteCollection ¶
func (discovery *DiscoveryV1) DeleteCollection(deleteCollectionOptions *DeleteCollectionOptions) (result *DeleteCollectionResponse, response *core.DetailedResponse, err error)
DeleteCollection : Delete a collection
func (*DiscoveryV1) DeleteCollectionWithContext ¶
func (discovery *DiscoveryV1) DeleteCollectionWithContext(ctx context.Context, deleteCollectionOptions *DeleteCollectionOptions) (result *DeleteCollectionResponse, response *core.DetailedResponse, err error)
DeleteCollectionWithContext is an alternate form of the DeleteCollection method which supports a Context parameter
func (*DiscoveryV1) DeleteConfiguration ¶
func (discovery *DiscoveryV1) DeleteConfiguration(deleteConfigurationOptions *DeleteConfigurationOptions) (result *DeleteConfigurationResponse, response *core.DetailedResponse, err error)
DeleteConfiguration : Delete a configuration The deletion is performed unconditionally. A configuration deletion request succeeds even if the configuration is referenced by a collection or document ingestion. However, documents that have already been submitted for processing continue to use the deleted configuration. Documents are always processed with a snapshot of the configuration as it existed at the time the document was submitted.
func (*DiscoveryV1) DeleteConfigurationWithContext ¶
func (discovery *DiscoveryV1) DeleteConfigurationWithContext(ctx context.Context, deleteConfigurationOptions *DeleteConfigurationOptions) (result *DeleteConfigurationResponse, response *core.DetailedResponse, err error)
DeleteConfigurationWithContext is an alternate form of the DeleteConfiguration method which supports a Context parameter
func (*DiscoveryV1) DeleteCredentials ¶
func (discovery *DiscoveryV1) DeleteCredentials(deleteCredentialsOptions *DeleteCredentialsOptions) (result *DeleteCredentials, response *core.DetailedResponse, err error)
DeleteCredentials : Delete credentials Deletes a set of stored credentials from your Discovery instance.
func (*DiscoveryV1) DeleteCredentialsWithContext ¶
func (discovery *DiscoveryV1) DeleteCredentialsWithContext(ctx context.Context, deleteCredentialsOptions *DeleteCredentialsOptions) (result *DeleteCredentials, response *core.DetailedResponse, err error)
DeleteCredentialsWithContext is an alternate form of the DeleteCredentials method which supports a Context parameter
func (*DiscoveryV1) DeleteDocument ¶
func (discovery *DiscoveryV1) DeleteDocument(deleteDocumentOptions *DeleteDocumentOptions) (result *DeleteDocumentResponse, response *core.DetailedResponse, err error)
DeleteDocument : Delete a document If the given document ID is invalid, or if the document is not found, then the a success response is returned (HTTP status code `200`) with the status set to 'deleted'.
func (*DiscoveryV1) DeleteDocumentWithContext ¶
func (discovery *DiscoveryV1) DeleteDocumentWithContext(ctx context.Context, deleteDocumentOptions *DeleteDocumentOptions) (result *DeleteDocumentResponse, response *core.DetailedResponse, err error)
DeleteDocumentWithContext is an alternate form of the DeleteDocument method which supports a Context parameter
func (*DiscoveryV1) DeleteEnvironment ¶
func (discovery *DiscoveryV1) DeleteEnvironment(deleteEnvironmentOptions *DeleteEnvironmentOptions) (result *DeleteEnvironmentResponse, response *core.DetailedResponse, err error)
DeleteEnvironment : Delete environment
func (*DiscoveryV1) DeleteEnvironmentWithContext ¶
func (discovery *DiscoveryV1) DeleteEnvironmentWithContext(ctx context.Context, deleteEnvironmentOptions *DeleteEnvironmentOptions) (result *DeleteEnvironmentResponse, response *core.DetailedResponse, err error)
DeleteEnvironmentWithContext is an alternate form of the DeleteEnvironment method which supports a Context parameter
func (*DiscoveryV1) DeleteExpansions ¶
func (discovery *DiscoveryV1) DeleteExpansions(deleteExpansionsOptions *DeleteExpansionsOptions) (response *core.DetailedResponse, err error)
DeleteExpansions : Delete the expansion list Remove the expansion information for this collection. The expansion list must be deleted to disable query expansion for a collection.
func (*DiscoveryV1) DeleteExpansionsWithContext ¶
func (discovery *DiscoveryV1) DeleteExpansionsWithContext(ctx context.Context, deleteExpansionsOptions *DeleteExpansionsOptions) (response *core.DetailedResponse, err error)
DeleteExpansionsWithContext is an alternate form of the DeleteExpansions method which supports a Context parameter
func (*DiscoveryV1) DeleteGateway ¶
func (discovery *DiscoveryV1) DeleteGateway(deleteGatewayOptions *DeleteGatewayOptions) (result *GatewayDelete, response *core.DetailedResponse, err error)
DeleteGateway : Delete Gateway Delete the specified gateway configuration.
func (*DiscoveryV1) DeleteGatewayWithContext ¶
func (discovery *DiscoveryV1) DeleteGatewayWithContext(ctx context.Context, deleteGatewayOptions *DeleteGatewayOptions) (result *GatewayDelete, response *core.DetailedResponse, err error)
DeleteGatewayWithContext is an alternate form of the DeleteGateway method which supports a Context parameter
func (*DiscoveryV1) DeleteStopwordList ¶
func (discovery *DiscoveryV1) DeleteStopwordList(deleteStopwordListOptions *DeleteStopwordListOptions) (response *core.DetailedResponse, err error)
DeleteStopwordList : Delete a custom stopword list Delete a custom stopword list from the collection. After a custom stopword list is deleted, the default list is used for the collection.
func (*DiscoveryV1) DeleteStopwordListWithContext ¶
func (discovery *DiscoveryV1) DeleteStopwordListWithContext(ctx context.Context, deleteStopwordListOptions *DeleteStopwordListOptions) (response *core.DetailedResponse, err error)
DeleteStopwordListWithContext is an alternate form of the DeleteStopwordList method which supports a Context parameter
func (*DiscoveryV1) DeleteTokenizationDictionary ¶
func (discovery *DiscoveryV1) DeleteTokenizationDictionary(deleteTokenizationDictionaryOptions *DeleteTokenizationDictionaryOptions) (response *core.DetailedResponse, err error)
DeleteTokenizationDictionary : Delete tokenization dictionary Delete the tokenization dictionary from the collection.
func (*DiscoveryV1) DeleteTokenizationDictionaryWithContext ¶
func (discovery *DiscoveryV1) DeleteTokenizationDictionaryWithContext(ctx context.Context, deleteTokenizationDictionaryOptions *DeleteTokenizationDictionaryOptions) (response *core.DetailedResponse, err error)
DeleteTokenizationDictionaryWithContext is an alternate form of the DeleteTokenizationDictionary method which supports a Context parameter
func (*DiscoveryV1) DeleteTrainingData ¶
func (discovery *DiscoveryV1) DeleteTrainingData(deleteTrainingDataOptions *DeleteTrainingDataOptions) (response *core.DetailedResponse, err error)
DeleteTrainingData : Delete a training data query Removes the training data query and all associated examples from the training data set.
func (*DiscoveryV1) DeleteTrainingDataWithContext ¶
func (discovery *DiscoveryV1) DeleteTrainingDataWithContext(ctx context.Context, deleteTrainingDataOptions *DeleteTrainingDataOptions) (response *core.DetailedResponse, err error)
DeleteTrainingDataWithContext is an alternate form of the DeleteTrainingData method which supports a Context parameter
func (*DiscoveryV1) DeleteTrainingExample ¶
func (discovery *DiscoveryV1) DeleteTrainingExample(deleteTrainingExampleOptions *DeleteTrainingExampleOptions) (response *core.DetailedResponse, err error)
DeleteTrainingExample : Delete example for training data query Deletes the example document with the given ID from the training data query.
func (*DiscoveryV1) DeleteTrainingExampleWithContext ¶
func (discovery *DiscoveryV1) DeleteTrainingExampleWithContext(ctx context.Context, deleteTrainingExampleOptions *DeleteTrainingExampleOptions) (response *core.DetailedResponse, err error)
DeleteTrainingExampleWithContext is an alternate form of the DeleteTrainingExample method which supports a Context parameter
func (*DiscoveryV1) DeleteUserData ¶
func (discovery *DiscoveryV1) DeleteUserData(deleteUserDataOptions *DeleteUserDataOptions) (response *core.DetailedResponse, err error)
DeleteUserData : Delete labeled data Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with the customer ID.
You associate a customer ID with data by passing the **X-Watson-Metadata** header with a request that passes data. For more information about personal data and customer IDs, see [Information security](https://cloud.ibm.com/docs/discovery?topic=discovery-information-security#information-security).
func (*DiscoveryV1) DeleteUserDataWithContext ¶
func (discovery *DiscoveryV1) DeleteUserDataWithContext(ctx context.Context, deleteUserDataOptions *DeleteUserDataOptions) (response *core.DetailedResponse, err error)
DeleteUserDataWithContext is an alternate form of the DeleteUserData method which supports a Context parameter
func (*DiscoveryV1) DisableRetries ¶
func (discovery *DiscoveryV1) DisableRetries()
DisableRetries disables automatic retries for requests invoked for this service instance.
func (*DiscoveryV1) DisableSSLVerification ¶
func (discovery *DiscoveryV1) DisableSSLVerification()
DisableSSLVerification bypasses verification of the server's SSL certificate
func (*DiscoveryV1) EnableRetries ¶
func (discovery *DiscoveryV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)
EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.
func (*DiscoveryV1) FederatedQuery ¶
func (discovery *DiscoveryV1) FederatedQuery(federatedQueryOptions *FederatedQueryOptions) (result *QueryResponse, response *core.DetailedResponse, err error)
FederatedQuery : Query multiple collections By using this method, you can construct long queries that search multiple collection. For details, see the [Discovery documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts).
func (*DiscoveryV1) FederatedQueryNotices ¶
func (discovery *DiscoveryV1) FederatedQueryNotices(federatedQueryNoticesOptions *FederatedQueryNoticesOptions) (result *QueryNoticesResponse, response *core.DetailedResponse, err error)
FederatedQueryNotices : Query multiple collection system notices Queries for notices (errors or warnings) that might have been generated by the system. Notices are generated when ingesting documents and performing relevance training. See the [Discovery documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts) for more details on the query language.
func (*DiscoveryV1) FederatedQueryNoticesWithContext ¶
func (discovery *DiscoveryV1) FederatedQueryNoticesWithContext(ctx context.Context, federatedQueryNoticesOptions *FederatedQueryNoticesOptions) (result *QueryNoticesResponse, response *core.DetailedResponse, err error)
FederatedQueryNoticesWithContext is an alternate form of the FederatedQueryNotices method which supports a Context parameter
func (*DiscoveryV1) FederatedQueryWithContext ¶
func (discovery *DiscoveryV1) FederatedQueryWithContext(ctx context.Context, federatedQueryOptions *FederatedQueryOptions) (result *QueryResponse, response *core.DetailedResponse, err error)
FederatedQueryWithContext is an alternate form of the FederatedQuery method which supports a Context parameter
func (*DiscoveryV1) GetAutocompletion ¶
func (discovery *DiscoveryV1) GetAutocompletion(getAutocompletionOptions *GetAutocompletionOptions) (result *Completions, response *core.DetailedResponse, err error)
GetAutocompletion : Get Autocomplete Suggestions Returns completion query suggestions for the specified prefix. /n/n **Important:** this method is only valid when using the Cloud Pak version of Discovery.
func (*DiscoveryV1) GetAutocompletionWithContext ¶
func (discovery *DiscoveryV1) GetAutocompletionWithContext(ctx context.Context, getAutocompletionOptions *GetAutocompletionOptions) (result *Completions, response *core.DetailedResponse, err error)
GetAutocompletionWithContext is an alternate form of the GetAutocompletion method which supports a Context parameter
func (*DiscoveryV1) GetCollection ¶
func (discovery *DiscoveryV1) GetCollection(getCollectionOptions *GetCollectionOptions) (result *Collection, response *core.DetailedResponse, err error)
GetCollection : Get collection details
func (*DiscoveryV1) GetCollectionWithContext ¶
func (discovery *DiscoveryV1) GetCollectionWithContext(ctx context.Context, getCollectionOptions *GetCollectionOptions) (result *Collection, response *core.DetailedResponse, err error)
GetCollectionWithContext is an alternate form of the GetCollection method which supports a Context parameter
func (*DiscoveryV1) GetConfiguration ¶
func (discovery *DiscoveryV1) GetConfiguration(getConfigurationOptions *GetConfigurationOptions) (result *Configuration, response *core.DetailedResponse, err error)
GetConfiguration : Get configuration details
func (*DiscoveryV1) GetConfigurationWithContext ¶
func (discovery *DiscoveryV1) GetConfigurationWithContext(ctx context.Context, getConfigurationOptions *GetConfigurationOptions) (result *Configuration, response *core.DetailedResponse, err error)
GetConfigurationWithContext is an alternate form of the GetConfiguration method which supports a Context parameter
func (*DiscoveryV1) GetCredentials ¶
func (discovery *DiscoveryV1) GetCredentials(getCredentialsOptions *GetCredentialsOptions) (result *Credentials, response *core.DetailedResponse, err error)
GetCredentials : View Credentials Returns details about the specified credentials.
**Note:** Secure credential information such as a password or SSH key is never returned and must be obtained from
the source system.
func (*DiscoveryV1) GetCredentialsWithContext ¶
func (discovery *DiscoveryV1) GetCredentialsWithContext(ctx context.Context, getCredentialsOptions *GetCredentialsOptions) (result *Credentials, response *core.DetailedResponse, err error)
GetCredentialsWithContext is an alternate form of the GetCredentials method which supports a Context parameter
func (*DiscoveryV1) GetDocumentStatus ¶
func (discovery *DiscoveryV1) GetDocumentStatus(getDocumentStatusOptions *GetDocumentStatusOptions) (result *DocumentStatus, response *core.DetailedResponse, err error)
GetDocumentStatus : Get document details Fetch status details about a submitted document. **Note:** this operation does not return the document itself. Instead, it returns only the document's processing status and any notices (warnings or errors) that were generated when the document was ingested. Use the query API to retrieve the actual document content.
func (*DiscoveryV1) GetDocumentStatusWithContext ¶
func (discovery *DiscoveryV1) GetDocumentStatusWithContext(ctx context.Context, getDocumentStatusOptions *GetDocumentStatusOptions) (result *DocumentStatus, response *core.DetailedResponse, err error)
GetDocumentStatusWithContext is an alternate form of the GetDocumentStatus method which supports a Context parameter
func (*DiscoveryV1) GetEnableGzipCompression ¶
func (discovery *DiscoveryV1) GetEnableGzipCompression() bool
GetEnableGzipCompression returns the service's EnableGzipCompression field
func (*DiscoveryV1) GetEnvironment ¶
func (discovery *DiscoveryV1) GetEnvironment(getEnvironmentOptions *GetEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)
GetEnvironment : Get environment info
func (*DiscoveryV1) GetEnvironmentWithContext ¶
func (discovery *DiscoveryV1) GetEnvironmentWithContext(ctx context.Context, getEnvironmentOptions *GetEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)
GetEnvironmentWithContext is an alternate form of the GetEnvironment method which supports a Context parameter
func (*DiscoveryV1) GetGateway ¶
func (discovery *DiscoveryV1) GetGateway(getGatewayOptions *GetGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)
GetGateway : List Gateway Details List information about the specified gateway.
func (*DiscoveryV1) GetGatewayWithContext ¶
func (discovery *DiscoveryV1) GetGatewayWithContext(ctx context.Context, getGatewayOptions *GetGatewayOptions) (result *Gateway, response *core.DetailedResponse, err error)
GetGatewayWithContext is an alternate form of the GetGateway method which supports a Context parameter
func (*DiscoveryV1) GetMetricsEventRate ¶
func (discovery *DiscoveryV1) GetMetricsEventRate(getMetricsEventRateOptions *GetMetricsEventRateOptions) (result *MetricResponse, response *core.DetailedResponse, err error)
GetMetricsEventRate : Percentage of queries with an associated event The percentage of queries using the **natural_language_query** parameter that have a corresponding "click" event over a specified time window. This metric requires having integrated event tracking in your application using the **Events** API.
func (*DiscoveryV1) GetMetricsEventRateWithContext ¶
func (discovery *DiscoveryV1) GetMetricsEventRateWithContext(ctx context.Context, getMetricsEventRateOptions *GetMetricsEventRateOptions) (result *MetricResponse, response *core.DetailedResponse, err error)
GetMetricsEventRateWithContext is an alternate form of the GetMetricsEventRate method which supports a Context parameter
func (*DiscoveryV1) GetMetricsQuery ¶
func (discovery *DiscoveryV1) GetMetricsQuery(getMetricsQueryOptions *GetMetricsQueryOptions) (result *MetricResponse, response *core.DetailedResponse, err error)
GetMetricsQuery : Number of queries over time Total number of queries using the **natural_language_query** parameter over a specific time window.
func (*DiscoveryV1) GetMetricsQueryEvent ¶
func (discovery *DiscoveryV1) GetMetricsQueryEvent(getMetricsQueryEventOptions *GetMetricsQueryEventOptions) (result *MetricResponse, response *core.DetailedResponse, err error)
GetMetricsQueryEvent : Number of queries with an event over time Total number of queries using the **natural_language_query** parameter that have a corresponding "click" event over a specified time window. This metric requires having integrated event tracking in your application using the **Events** API.
func (*DiscoveryV1) GetMetricsQueryEventWithContext ¶
func (discovery *DiscoveryV1) GetMetricsQueryEventWithContext(ctx context.Context, getMetricsQueryEventOptions *GetMetricsQueryEventOptions) (result *MetricResponse, response *core.DetailedResponse, err error)
GetMetricsQueryEventWithContext is an alternate form of the GetMetricsQueryEvent method which supports a Context parameter
func (*DiscoveryV1) GetMetricsQueryNoResults ¶
func (discovery *DiscoveryV1) GetMetricsQueryNoResults(getMetricsQueryNoResultsOptions *GetMetricsQueryNoResultsOptions) (result *MetricResponse, response *core.DetailedResponse, err error)
GetMetricsQueryNoResults : Number of queries with no search results over time Total number of queries using the **natural_language_query** parameter that have no results returned over a specified time window.
func (*DiscoveryV1) GetMetricsQueryNoResultsWithContext ¶
func (discovery *DiscoveryV1) GetMetricsQueryNoResultsWithContext(ctx context.Context, getMetricsQueryNoResultsOptions *GetMetricsQueryNoResultsOptions) (result *MetricResponse, response *core.DetailedResponse, err error)
GetMetricsQueryNoResultsWithContext is an alternate form of the GetMetricsQueryNoResults method which supports a Context parameter
func (*DiscoveryV1) GetMetricsQueryTokenEvent ¶
func (discovery *DiscoveryV1) GetMetricsQueryTokenEvent(getMetricsQueryTokenEventOptions *GetMetricsQueryTokenEventOptions) (result *MetricTokenResponse, response *core.DetailedResponse, err error)
GetMetricsQueryTokenEvent : Most frequent query tokens with an event The most frequent query tokens parsed from the **natural_language_query** parameter and their corresponding "click" event rate within the recording period (queries and events are stored for 30 days). A query token is an individual word or unigram within the query string.
func (*DiscoveryV1) GetMetricsQueryTokenEventWithContext ¶
func (discovery *DiscoveryV1) GetMetricsQueryTokenEventWithContext(ctx context.Context, getMetricsQueryTokenEventOptions *GetMetricsQueryTokenEventOptions) (result *MetricTokenResponse, response *core.DetailedResponse, err error)
GetMetricsQueryTokenEventWithContext is an alternate form of the GetMetricsQueryTokenEvent method which supports a Context parameter
func (*DiscoveryV1) GetMetricsQueryWithContext ¶
func (discovery *DiscoveryV1) GetMetricsQueryWithContext(ctx context.Context, getMetricsQueryOptions *GetMetricsQueryOptions) (result *MetricResponse, response *core.DetailedResponse, err error)
GetMetricsQueryWithContext is an alternate form of the GetMetricsQuery method which supports a Context parameter
func (*DiscoveryV1) GetServiceURL ¶
func (discovery *DiscoveryV1) GetServiceURL() string
GetServiceURL returns the service URL
func (*DiscoveryV1) GetStopwordListStatus ¶
func (discovery *DiscoveryV1) GetStopwordListStatus(getStopwordListStatusOptions *GetStopwordListStatusOptions) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
GetStopwordListStatus : Get stopword list status Returns the current status of the stopword list for the specified collection.
func (*DiscoveryV1) GetStopwordListStatusWithContext ¶
func (discovery *DiscoveryV1) GetStopwordListStatusWithContext(ctx context.Context, getStopwordListStatusOptions *GetStopwordListStatusOptions) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
GetStopwordListStatusWithContext is an alternate form of the GetStopwordListStatus method which supports a Context parameter
func (*DiscoveryV1) GetTokenizationDictionaryStatus ¶
func (discovery *DiscoveryV1) GetTokenizationDictionaryStatus(getTokenizationDictionaryStatusOptions *GetTokenizationDictionaryStatusOptions) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
GetTokenizationDictionaryStatus : Get tokenization dictionary status Returns the current status of the tokenization dictionary for the specified collection.
func (*DiscoveryV1) GetTokenizationDictionaryStatusWithContext ¶
func (discovery *DiscoveryV1) GetTokenizationDictionaryStatusWithContext(ctx context.Context, getTokenizationDictionaryStatusOptions *GetTokenizationDictionaryStatusOptions) (result *TokenDictStatusResponse, response *core.DetailedResponse, err error)
GetTokenizationDictionaryStatusWithContext is an alternate form of the GetTokenizationDictionaryStatus method which supports a Context parameter
func (*DiscoveryV1) GetTrainingData ¶
func (discovery *DiscoveryV1) GetTrainingData(getTrainingDataOptions *GetTrainingDataOptions) (result *TrainingQuery, response *core.DetailedResponse, err error)
GetTrainingData : Get details about a query Gets details for a specific training data query, including the query string and all examples.
func (*DiscoveryV1) GetTrainingDataWithContext ¶
func (discovery *DiscoveryV1) GetTrainingDataWithContext(ctx context.Context, getTrainingDataOptions *GetTrainingDataOptions) (result *TrainingQuery, response *core.DetailedResponse, err error)
GetTrainingDataWithContext is an alternate form of the GetTrainingData method which supports a Context parameter
func (*DiscoveryV1) GetTrainingExample ¶
func (discovery *DiscoveryV1) GetTrainingExample(getTrainingExampleOptions *GetTrainingExampleOptions) (result *TrainingExample, response *core.DetailedResponse, err error)
GetTrainingExample : Get details for training data example Gets the details for this training example.
func (*DiscoveryV1) GetTrainingExampleWithContext ¶
func (discovery *DiscoveryV1) GetTrainingExampleWithContext(ctx context.Context, getTrainingExampleOptions *GetTrainingExampleOptions) (result *TrainingExample, response *core.DetailedResponse, err error)
GetTrainingExampleWithContext is an alternate form of the GetTrainingExample method which supports a Context parameter
func (*DiscoveryV1) ListCollectionFields ¶
func (discovery *DiscoveryV1) ListCollectionFields(listCollectionFieldsOptions *ListCollectionFieldsOptions) (result *ListCollectionFieldsResponse, response *core.DetailedResponse, err error)
ListCollectionFields : List collection fields Gets a list of the unique fields (and their types) stored in the index.
func (*DiscoveryV1) ListCollectionFieldsWithContext ¶
func (discovery *DiscoveryV1) ListCollectionFieldsWithContext(ctx context.Context, listCollectionFieldsOptions *ListCollectionFieldsOptions) (result *ListCollectionFieldsResponse, response *core.DetailedResponse, err error)
ListCollectionFieldsWithContext is an alternate form of the ListCollectionFields method which supports a Context parameter
func (*DiscoveryV1) ListCollections ¶
func (discovery *DiscoveryV1) ListCollections(listCollectionsOptions *ListCollectionsOptions) (result *ListCollectionsResponse, response *core.DetailedResponse, err error)
ListCollections : List collections Lists existing collections for the service instance.
func (*DiscoveryV1) ListCollectionsWithContext ¶
func (discovery *DiscoveryV1) ListCollectionsWithContext(ctx context.Context, listCollectionsOptions *ListCollectionsOptions) (result *ListCollectionsResponse, response *core.DetailedResponse, err error)
ListCollectionsWithContext is an alternate form of the ListCollections method which supports a Context parameter
func (*DiscoveryV1) ListConfigurations ¶
func (discovery *DiscoveryV1) ListConfigurations(listConfigurationsOptions *ListConfigurationsOptions) (result *ListConfigurationsResponse, response *core.DetailedResponse, err error)
ListConfigurations : List configurations Lists existing configurations for the service instance.
func (*DiscoveryV1) ListConfigurationsWithContext ¶
func (discovery *DiscoveryV1) ListConfigurationsWithContext(ctx context.Context, listConfigurationsOptions *ListConfigurationsOptions) (result *ListConfigurationsResponse, response *core.DetailedResponse, err error)
ListConfigurationsWithContext is an alternate form of the ListConfigurations method which supports a Context parameter
func (*DiscoveryV1) ListCredentials ¶
func (discovery *DiscoveryV1) ListCredentials(listCredentialsOptions *ListCredentialsOptions) (result *CredentialsList, response *core.DetailedResponse, err error)
ListCredentials : List credentials List all the source credentials that have been created for this service instance.
**Note:** All credentials are sent over an encrypted connection and encrypted at rest.
func (*DiscoveryV1) ListCredentialsWithContext ¶
func (discovery *DiscoveryV1) ListCredentialsWithContext(ctx context.Context, listCredentialsOptions *ListCredentialsOptions) (result *CredentialsList, response *core.DetailedResponse, err error)
ListCredentialsWithContext is an alternate form of the ListCredentials method which supports a Context parameter
func (*DiscoveryV1) ListEnvironments ¶
func (discovery *DiscoveryV1) ListEnvironments(listEnvironmentsOptions *ListEnvironmentsOptions) (result *ListEnvironmentsResponse, response *core.DetailedResponse, err error)
ListEnvironments : List environments List existing environments for the service instance.
func (*DiscoveryV1) ListEnvironmentsWithContext ¶
func (discovery *DiscoveryV1) ListEnvironmentsWithContext(ctx context.Context, listEnvironmentsOptions *ListEnvironmentsOptions) (result *ListEnvironmentsResponse, response *core.DetailedResponse, err error)
ListEnvironmentsWithContext is an alternate form of the ListEnvironments method which supports a Context parameter
func (*DiscoveryV1) ListExpansions ¶
func (discovery *DiscoveryV1) ListExpansions(listExpansionsOptions *ListExpansionsOptions) (result *Expansions, response *core.DetailedResponse, err error)
ListExpansions : Get the expansion list Returns the current expansion list for the specified collection. If an expansion list is not specified, an object with empty expansion arrays is returned.
func (*DiscoveryV1) ListExpansionsWithContext ¶
func (discovery *DiscoveryV1) ListExpansionsWithContext(ctx context.Context, listExpansionsOptions *ListExpansionsOptions) (result *Expansions, response *core.DetailedResponse, err error)
ListExpansionsWithContext is an alternate form of the ListExpansions method which supports a Context parameter
func (*DiscoveryV1) ListFields ¶
func (discovery *DiscoveryV1) ListFields(listFieldsOptions *ListFieldsOptions) (result *ListCollectionFieldsResponse, response *core.DetailedResponse, err error)
ListFields : List fields across collections Gets a list of the unique fields (and their types) stored in the indexes of the specified collections.
func (*DiscoveryV1) ListFieldsWithContext ¶
func (discovery *DiscoveryV1) ListFieldsWithContext(ctx context.Context, listFieldsOptions *ListFieldsOptions) (result *ListCollectionFieldsResponse, response *core.DetailedResponse, err error)
ListFieldsWithContext is an alternate form of the ListFields method which supports a Context parameter
func (*DiscoveryV1) ListGateways ¶
func (discovery *DiscoveryV1) ListGateways(listGatewaysOptions *ListGatewaysOptions) (result *GatewayList, response *core.DetailedResponse, err error)
ListGateways : List Gateways List the currently configured gateways.
func (*DiscoveryV1) ListGatewaysWithContext ¶
func (discovery *DiscoveryV1) ListGatewaysWithContext(ctx context.Context, listGatewaysOptions *ListGatewaysOptions) (result *GatewayList, response *core.DetailedResponse, err error)
ListGatewaysWithContext is an alternate form of the ListGateways method which supports a Context parameter
func (*DiscoveryV1) ListTrainingData ¶
func (discovery *DiscoveryV1) ListTrainingData(listTrainingDataOptions *ListTrainingDataOptions) (result *TrainingDataSet, response *core.DetailedResponse, err error)
ListTrainingData : List training data Lists the training data for the specified collection.
func (*DiscoveryV1) ListTrainingDataWithContext ¶
func (discovery *DiscoveryV1) ListTrainingDataWithContext(ctx context.Context, listTrainingDataOptions *ListTrainingDataOptions) (result *TrainingDataSet, response *core.DetailedResponse, err error)
ListTrainingDataWithContext is an alternate form of the ListTrainingData method which supports a Context parameter
func (*DiscoveryV1) ListTrainingExamples ¶
func (discovery *DiscoveryV1) ListTrainingExamples(listTrainingExamplesOptions *ListTrainingExamplesOptions) (result *TrainingExampleList, response *core.DetailedResponse, err error)
ListTrainingExamples : List examples for a training data query List all examples for this training data query.
func (*DiscoveryV1) ListTrainingExamplesWithContext ¶
func (discovery *DiscoveryV1) ListTrainingExamplesWithContext(ctx context.Context, listTrainingExamplesOptions *ListTrainingExamplesOptions) (result *TrainingExampleList, response *core.DetailedResponse, err error)
ListTrainingExamplesWithContext is an alternate form of the ListTrainingExamples method which supports a Context parameter
func (*DiscoveryV1) NewAddDocumentOptions ¶
func (*DiscoveryV1) NewAddDocumentOptions(environmentID string, collectionID string) *AddDocumentOptions
NewAddDocumentOptions : Instantiate AddDocumentOptions
func (*DiscoveryV1) NewAddTrainingDataOptions ¶
func (*DiscoveryV1) NewAddTrainingDataOptions(environmentID string, collectionID string) *AddTrainingDataOptions
NewAddTrainingDataOptions : Instantiate AddTrainingDataOptions
func (*DiscoveryV1) NewConfiguration ¶
func (*DiscoveryV1) NewConfiguration(name string) (_model *Configuration, err error)
NewConfiguration : Instantiate Configuration (Generic Model Constructor)
func (*DiscoveryV1) NewCreateCollectionOptions ¶
func (*DiscoveryV1) NewCreateCollectionOptions(environmentID string, name string) *CreateCollectionOptions
NewCreateCollectionOptions : Instantiate CreateCollectionOptions
func (*DiscoveryV1) NewCreateConfigurationOptions ¶
func (*DiscoveryV1) NewCreateConfigurationOptions(environmentID string, name string) *CreateConfigurationOptions
NewCreateConfigurationOptions : Instantiate CreateConfigurationOptions
func (*DiscoveryV1) NewCreateCredentialsOptions ¶
func (*DiscoveryV1) NewCreateCredentialsOptions(environmentID string) *CreateCredentialsOptions
NewCreateCredentialsOptions : Instantiate CreateCredentialsOptions
func (*DiscoveryV1) NewCreateEnvironmentOptions ¶
func (*DiscoveryV1) NewCreateEnvironmentOptions(name string) *CreateEnvironmentOptions
NewCreateEnvironmentOptions : Instantiate CreateEnvironmentOptions
func (*DiscoveryV1) NewCreateEventOptions ¶
func (*DiscoveryV1) NewCreateEventOptions(typeVar string, data *EventData) *CreateEventOptions
NewCreateEventOptions : Instantiate CreateEventOptions
func (*DiscoveryV1) NewCreateExpansionsOptions ¶
func (*DiscoveryV1) NewCreateExpansionsOptions(environmentID string, collectionID string, expansions []Expansion) *CreateExpansionsOptions
NewCreateExpansionsOptions : Instantiate CreateExpansionsOptions
func (*DiscoveryV1) NewCreateGatewayOptions ¶
func (*DiscoveryV1) NewCreateGatewayOptions(environmentID string) *CreateGatewayOptions
NewCreateGatewayOptions : Instantiate CreateGatewayOptions
func (*DiscoveryV1) NewCreateStopwordListOptions ¶
func (*DiscoveryV1) NewCreateStopwordListOptions(environmentID string, collectionID string, stopwordFile io.ReadCloser, stopwordFilename string) *CreateStopwordListOptions
NewCreateStopwordListOptions : Instantiate CreateStopwordListOptions
func (*DiscoveryV1) NewCreateTokenizationDictionaryOptions ¶
func (*DiscoveryV1) NewCreateTokenizationDictionaryOptions(environmentID string, collectionID string) *CreateTokenizationDictionaryOptions
NewCreateTokenizationDictionaryOptions : Instantiate CreateTokenizationDictionaryOptions
func (*DiscoveryV1) NewCreateTrainingExampleOptions ¶
func (*DiscoveryV1) NewCreateTrainingExampleOptions(environmentID string, collectionID string, queryID string) *CreateTrainingExampleOptions
NewCreateTrainingExampleOptions : Instantiate CreateTrainingExampleOptions
func (*DiscoveryV1) NewDeleteAllTrainingDataOptions ¶
func (*DiscoveryV1) NewDeleteAllTrainingDataOptions(environmentID string, collectionID string) *DeleteAllTrainingDataOptions
NewDeleteAllTrainingDataOptions : Instantiate DeleteAllTrainingDataOptions
func (*DiscoveryV1) NewDeleteCollectionOptions ¶
func (*DiscoveryV1) NewDeleteCollectionOptions(environmentID string, collectionID string) *DeleteCollectionOptions
NewDeleteCollectionOptions : Instantiate DeleteCollectionOptions
func (*DiscoveryV1) NewDeleteConfigurationOptions ¶
func (*DiscoveryV1) NewDeleteConfigurationOptions(environmentID string, configurationID string) *DeleteConfigurationOptions
NewDeleteConfigurationOptions : Instantiate DeleteConfigurationOptions
func (*DiscoveryV1) NewDeleteCredentialsOptions ¶
func (*DiscoveryV1) NewDeleteCredentialsOptions(environmentID string, credentialID string) *DeleteCredentialsOptions
NewDeleteCredentialsOptions : Instantiate DeleteCredentialsOptions
func (*DiscoveryV1) NewDeleteDocumentOptions ¶
func (*DiscoveryV1) NewDeleteDocumentOptions(environmentID string, collectionID string, documentID string) *DeleteDocumentOptions
NewDeleteDocumentOptions : Instantiate DeleteDocumentOptions
func (*DiscoveryV1) NewDeleteEnvironmentOptions ¶
func (*DiscoveryV1) NewDeleteEnvironmentOptions(environmentID string) *DeleteEnvironmentOptions
NewDeleteEnvironmentOptions : Instantiate DeleteEnvironmentOptions
func (*DiscoveryV1) NewDeleteExpansionsOptions ¶
func (*DiscoveryV1) NewDeleteExpansionsOptions(environmentID string, collectionID string) *DeleteExpansionsOptions
NewDeleteExpansionsOptions : Instantiate DeleteExpansionsOptions
func (*DiscoveryV1) NewDeleteGatewayOptions ¶
func (*DiscoveryV1) NewDeleteGatewayOptions(environmentID string, gatewayID string) *DeleteGatewayOptions
NewDeleteGatewayOptions : Instantiate DeleteGatewayOptions
func (*DiscoveryV1) NewDeleteStopwordListOptions ¶
func (*DiscoveryV1) NewDeleteStopwordListOptions(environmentID string, collectionID string) *DeleteStopwordListOptions
NewDeleteStopwordListOptions : Instantiate DeleteStopwordListOptions
func (*DiscoveryV1) NewDeleteTokenizationDictionaryOptions ¶
func (*DiscoveryV1) NewDeleteTokenizationDictionaryOptions(environmentID string, collectionID string) *DeleteTokenizationDictionaryOptions
NewDeleteTokenizationDictionaryOptions : Instantiate DeleteTokenizationDictionaryOptions
func (*DiscoveryV1) NewDeleteTrainingDataOptions ¶
func (*DiscoveryV1) NewDeleteTrainingDataOptions(environmentID string, collectionID string, queryID string) *DeleteTrainingDataOptions
NewDeleteTrainingDataOptions : Instantiate DeleteTrainingDataOptions
func (*DiscoveryV1) NewDeleteTrainingExampleOptions ¶
func (*DiscoveryV1) NewDeleteTrainingExampleOptions(environmentID string, collectionID string, queryID string, exampleID string) *DeleteTrainingExampleOptions
NewDeleteTrainingExampleOptions : Instantiate DeleteTrainingExampleOptions
func (*DiscoveryV1) NewDeleteUserDataOptions ¶
func (*DiscoveryV1) NewDeleteUserDataOptions(customerID string) *DeleteUserDataOptions
NewDeleteUserDataOptions : Instantiate DeleteUserDataOptions
func (*DiscoveryV1) NewEnrichment ¶
func (*DiscoveryV1) NewEnrichment(destinationField string, sourceField string, enrichment string) (_model *Enrichment, err error)
NewEnrichment : Instantiate Enrichment (Generic Model Constructor)
func (*DiscoveryV1) NewEventData ¶
func (*DiscoveryV1) NewEventData(environmentID string, sessionToken string, collectionID string, documentID string) (_model *EventData, err error)
NewEventData : Instantiate EventData (Generic Model Constructor)
func (*DiscoveryV1) NewExpansion ¶
func (*DiscoveryV1) NewExpansion(expandedTerms []string) (_model *Expansion, err error)
NewExpansion : Instantiate Expansion (Generic Model Constructor)
func (*DiscoveryV1) NewExpansions ¶
func (*DiscoveryV1) NewExpansions(expansions []Expansion) (_model *Expansions, err error)
NewExpansions : Instantiate Expansions (Generic Model Constructor)
func (*DiscoveryV1) NewFederatedQueryNoticesOptions ¶
func (*DiscoveryV1) NewFederatedQueryNoticesOptions(environmentID string, collectionIds []string) *FederatedQueryNoticesOptions
NewFederatedQueryNoticesOptions : Instantiate FederatedQueryNoticesOptions
func (*DiscoveryV1) NewFederatedQueryOptions ¶
func (*DiscoveryV1) NewFederatedQueryOptions(environmentID string, collectionIds string) *FederatedQueryOptions
NewFederatedQueryOptions : Instantiate FederatedQueryOptions
func (*DiscoveryV1) NewGetAutocompletionOptions ¶
func (*DiscoveryV1) NewGetAutocompletionOptions(environmentID string, collectionID string, prefix string) *GetAutocompletionOptions
NewGetAutocompletionOptions : Instantiate GetAutocompletionOptions
func (*DiscoveryV1) NewGetCollectionOptions ¶
func (*DiscoveryV1) NewGetCollectionOptions(environmentID string, collectionID string) *GetCollectionOptions
NewGetCollectionOptions : Instantiate GetCollectionOptions
func (*DiscoveryV1) NewGetConfigurationOptions ¶
func (*DiscoveryV1) NewGetConfigurationOptions(environmentID string, configurationID string) *GetConfigurationOptions
NewGetConfigurationOptions : Instantiate GetConfigurationOptions
func (*DiscoveryV1) NewGetCredentialsOptions ¶
func (*DiscoveryV1) NewGetCredentialsOptions(environmentID string, credentialID string) *GetCredentialsOptions
NewGetCredentialsOptions : Instantiate GetCredentialsOptions
func (*DiscoveryV1) NewGetDocumentStatusOptions ¶
func (*DiscoveryV1) NewGetDocumentStatusOptions(environmentID string, collectionID string, documentID string) *GetDocumentStatusOptions
NewGetDocumentStatusOptions : Instantiate GetDocumentStatusOptions
func (*DiscoveryV1) NewGetEnvironmentOptions ¶
func (*DiscoveryV1) NewGetEnvironmentOptions(environmentID string) *GetEnvironmentOptions
NewGetEnvironmentOptions : Instantiate GetEnvironmentOptions
func (*DiscoveryV1) NewGetGatewayOptions ¶
func (*DiscoveryV1) NewGetGatewayOptions(environmentID string, gatewayID string) *GetGatewayOptions
NewGetGatewayOptions : Instantiate GetGatewayOptions
func (*DiscoveryV1) NewGetMetricsEventRateOptions ¶
func (*DiscoveryV1) NewGetMetricsEventRateOptions() *GetMetricsEventRateOptions
NewGetMetricsEventRateOptions : Instantiate GetMetricsEventRateOptions
func (*DiscoveryV1) NewGetMetricsQueryEventOptions ¶
func (*DiscoveryV1) NewGetMetricsQueryEventOptions() *GetMetricsQueryEventOptions
NewGetMetricsQueryEventOptions : Instantiate GetMetricsQueryEventOptions
func (*DiscoveryV1) NewGetMetricsQueryNoResultsOptions ¶
func (*DiscoveryV1) NewGetMetricsQueryNoResultsOptions() *GetMetricsQueryNoResultsOptions
NewGetMetricsQueryNoResultsOptions : Instantiate GetMetricsQueryNoResultsOptions
func (*DiscoveryV1) NewGetMetricsQueryOptions ¶
func (*DiscoveryV1) NewGetMetricsQueryOptions() *GetMetricsQueryOptions
NewGetMetricsQueryOptions : Instantiate GetMetricsQueryOptions
func (*DiscoveryV1) NewGetMetricsQueryTokenEventOptions ¶
func (*DiscoveryV1) NewGetMetricsQueryTokenEventOptions() *GetMetricsQueryTokenEventOptions
NewGetMetricsQueryTokenEventOptions : Instantiate GetMetricsQueryTokenEventOptions
func (*DiscoveryV1) NewGetStopwordListStatusOptions ¶
func (*DiscoveryV1) NewGetStopwordListStatusOptions(environmentID string, collectionID string) *GetStopwordListStatusOptions
NewGetStopwordListStatusOptions : Instantiate GetStopwordListStatusOptions
func (*DiscoveryV1) NewGetTokenizationDictionaryStatusOptions ¶
func (*DiscoveryV1) NewGetTokenizationDictionaryStatusOptions(environmentID string, collectionID string) *GetTokenizationDictionaryStatusOptions
NewGetTokenizationDictionaryStatusOptions : Instantiate GetTokenizationDictionaryStatusOptions
func (*DiscoveryV1) NewGetTrainingDataOptions ¶
func (*DiscoveryV1) NewGetTrainingDataOptions(environmentID string, collectionID string, queryID string) *GetTrainingDataOptions
NewGetTrainingDataOptions : Instantiate GetTrainingDataOptions
func (*DiscoveryV1) NewGetTrainingExampleOptions ¶
func (*DiscoveryV1) NewGetTrainingExampleOptions(environmentID string, collectionID string, queryID string, exampleID string) *GetTrainingExampleOptions
NewGetTrainingExampleOptions : Instantiate GetTrainingExampleOptions
func (*DiscoveryV1) NewListCollectionFieldsOptions ¶
func (*DiscoveryV1) NewListCollectionFieldsOptions(environmentID string, collectionID string) *ListCollectionFieldsOptions
NewListCollectionFieldsOptions : Instantiate ListCollectionFieldsOptions
func (*DiscoveryV1) NewListCollectionsOptions ¶
func (*DiscoveryV1) NewListCollectionsOptions(environmentID string) *ListCollectionsOptions
NewListCollectionsOptions : Instantiate ListCollectionsOptions
func (*DiscoveryV1) NewListConfigurationsOptions ¶
func (*DiscoveryV1) NewListConfigurationsOptions(environmentID string) *ListConfigurationsOptions
NewListConfigurationsOptions : Instantiate ListConfigurationsOptions
func (*DiscoveryV1) NewListCredentialsOptions ¶
func (*DiscoveryV1) NewListCredentialsOptions(environmentID string) *ListCredentialsOptions
NewListCredentialsOptions : Instantiate ListCredentialsOptions
func (*DiscoveryV1) NewListEnvironmentsOptions ¶
func (*DiscoveryV1) NewListEnvironmentsOptions() *ListEnvironmentsOptions
NewListEnvironmentsOptions : Instantiate ListEnvironmentsOptions
func (*DiscoveryV1) NewListExpansionsOptions ¶
func (*DiscoveryV1) NewListExpansionsOptions(environmentID string, collectionID string) *ListExpansionsOptions
NewListExpansionsOptions : Instantiate ListExpansionsOptions
func (*DiscoveryV1) NewListFieldsOptions ¶
func (*DiscoveryV1) NewListFieldsOptions(environmentID string, collectionIds []string) *ListFieldsOptions
NewListFieldsOptions : Instantiate ListFieldsOptions
func (*DiscoveryV1) NewListGatewaysOptions ¶
func (*DiscoveryV1) NewListGatewaysOptions(environmentID string) *ListGatewaysOptions
NewListGatewaysOptions : Instantiate ListGatewaysOptions
func (*DiscoveryV1) NewListTrainingDataOptions ¶
func (*DiscoveryV1) NewListTrainingDataOptions(environmentID string, collectionID string) *ListTrainingDataOptions
NewListTrainingDataOptions : Instantiate ListTrainingDataOptions
func (*DiscoveryV1) NewListTrainingExamplesOptions ¶
func (*DiscoveryV1) NewListTrainingExamplesOptions(environmentID string, collectionID string, queryID string) *ListTrainingExamplesOptions
NewListTrainingExamplesOptions : Instantiate ListTrainingExamplesOptions
func (*DiscoveryV1) NewQueryLogOptions ¶
func (*DiscoveryV1) NewQueryLogOptions() *QueryLogOptions
NewQueryLogOptions : Instantiate QueryLogOptions
func (*DiscoveryV1) NewQueryNoticesOptions ¶
func (*DiscoveryV1) NewQueryNoticesOptions(environmentID string, collectionID string) *QueryNoticesOptions
NewQueryNoticesOptions : Instantiate QueryNoticesOptions
func (*DiscoveryV1) NewQueryOptions ¶
func (*DiscoveryV1) NewQueryOptions(environmentID string, collectionID string) *QueryOptions
NewQueryOptions : Instantiate QueryOptions
func (*DiscoveryV1) NewSourceOptionsBuckets ¶
func (*DiscoveryV1) NewSourceOptionsBuckets(name string) (_model *SourceOptionsBuckets, err error)
NewSourceOptionsBuckets : Instantiate SourceOptionsBuckets (Generic Model Constructor)
func (*DiscoveryV1) NewSourceOptionsFolder ¶
func (*DiscoveryV1) NewSourceOptionsFolder(ownerUserID string, folderID string) (_model *SourceOptionsFolder, err error)
NewSourceOptionsFolder : Instantiate SourceOptionsFolder (Generic Model Constructor)
func (*DiscoveryV1) NewSourceOptionsObject ¶
func (*DiscoveryV1) NewSourceOptionsObject(name string) (_model *SourceOptionsObject, err error)
NewSourceOptionsObject : Instantiate SourceOptionsObject (Generic Model Constructor)
func (*DiscoveryV1) NewSourceOptionsSiteColl ¶
func (*DiscoveryV1) NewSourceOptionsSiteColl(siteCollectionPath string) (_model *SourceOptionsSiteColl, err error)
NewSourceOptionsSiteColl : Instantiate SourceOptionsSiteColl (Generic Model Constructor)
func (*DiscoveryV1) NewSourceOptionsWebCrawl ¶
func (*DiscoveryV1) NewSourceOptionsWebCrawl(url string) (_model *SourceOptionsWebCrawl, err error)
NewSourceOptionsWebCrawl : Instantiate SourceOptionsWebCrawl (Generic Model Constructor)
func (*DiscoveryV1) NewTokenDictRule ¶
func (*DiscoveryV1) NewTokenDictRule(text string, tokens []string, partOfSpeech string) (_model *TokenDictRule, err error)
NewTokenDictRule : Instantiate TokenDictRule (Generic Model Constructor)
func (*DiscoveryV1) NewUpdateCollectionOptions ¶
func (*DiscoveryV1) NewUpdateCollectionOptions(environmentID string, collectionID string, name string) *UpdateCollectionOptions
NewUpdateCollectionOptions : Instantiate UpdateCollectionOptions
func (*DiscoveryV1) NewUpdateConfigurationOptions ¶
func (*DiscoveryV1) NewUpdateConfigurationOptions(environmentID string, configurationID string, name string) *UpdateConfigurationOptions
NewUpdateConfigurationOptions : Instantiate UpdateConfigurationOptions
func (*DiscoveryV1) NewUpdateCredentialsOptions ¶
func (*DiscoveryV1) NewUpdateCredentialsOptions(environmentID string, credentialID string) *UpdateCredentialsOptions
NewUpdateCredentialsOptions : Instantiate UpdateCredentialsOptions
func (*DiscoveryV1) NewUpdateDocumentOptions ¶
func (*DiscoveryV1) NewUpdateDocumentOptions(environmentID string, collectionID string, documentID string) *UpdateDocumentOptions
NewUpdateDocumentOptions : Instantiate UpdateDocumentOptions
func (*DiscoveryV1) NewUpdateEnvironmentOptions ¶
func (*DiscoveryV1) NewUpdateEnvironmentOptions(environmentID string) *UpdateEnvironmentOptions
NewUpdateEnvironmentOptions : Instantiate UpdateEnvironmentOptions
func (*DiscoveryV1) NewUpdateTrainingExampleOptions ¶
func (*DiscoveryV1) NewUpdateTrainingExampleOptions(environmentID string, collectionID string, queryID string, exampleID string) *UpdateTrainingExampleOptions
NewUpdateTrainingExampleOptions : Instantiate UpdateTrainingExampleOptions
func (*DiscoveryV1) Query ¶
func (discovery *DiscoveryV1) Query(queryOptions *QueryOptions) (result *QueryResponse, response *core.DetailedResponse, err error)
Query : Query a collection By using this method, you can construct long queries. For details, see the [Discovery documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts).
func (*DiscoveryV1) QueryLog ¶
func (discovery *DiscoveryV1) QueryLog(queryLogOptions *QueryLogOptions) (result *LogQueryResponse, response *core.DetailedResponse, err error)
QueryLog : Search the query and event log Searches the query and event log to find query sessions that match the specified criteria. Searching the **logs** endpoint uses the standard Discovery query syntax for the parameters that are supported.
func (*DiscoveryV1) QueryLogWithContext ¶
func (discovery *DiscoveryV1) QueryLogWithContext(ctx context.Context, queryLogOptions *QueryLogOptions) (result *LogQueryResponse, response *core.DetailedResponse, err error)
QueryLogWithContext is an alternate form of the QueryLog method which supports a Context parameter
func (*DiscoveryV1) QueryNotices ¶
func (discovery *DiscoveryV1) QueryNotices(queryNoticesOptions *QueryNoticesOptions) (result *QueryNoticesResponse, response *core.DetailedResponse, err error)
QueryNotices : Query system notices Queries for notices (errors or warnings) that might have been generated by the system. Notices are generated when ingesting documents and performing relevance training. See the [Discovery documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts) for more details on the query language.
func (*DiscoveryV1) QueryNoticesWithContext ¶
func (discovery *DiscoveryV1) QueryNoticesWithContext(ctx context.Context, queryNoticesOptions *QueryNoticesOptions) (result *QueryNoticesResponse, response *core.DetailedResponse, err error)
QueryNoticesWithContext is an alternate form of the QueryNotices method which supports a Context parameter
func (*DiscoveryV1) QueryWithContext ¶
func (discovery *DiscoveryV1) QueryWithContext(ctx context.Context, queryOptions *QueryOptions) (result *QueryResponse, response *core.DetailedResponse, err error)
QueryWithContext is an alternate form of the Query method which supports a Context parameter
func (*DiscoveryV1) SetDefaultHeaders ¶
func (discovery *DiscoveryV1) SetDefaultHeaders(headers http.Header)
SetDefaultHeaders sets HTTP headers to be sent in every request
func (*DiscoveryV1) SetEnableGzipCompression ¶
func (discovery *DiscoveryV1) SetEnableGzipCompression(enableGzip bool)
SetEnableGzipCompression sets the service's EnableGzipCompression field
func (*DiscoveryV1) SetServiceURL ¶
func (discovery *DiscoveryV1) SetServiceURL(url string) error
SetServiceURL sets the service URL
func (*DiscoveryV1) UpdateCollection ¶
func (discovery *DiscoveryV1) UpdateCollection(updateCollectionOptions *UpdateCollectionOptions) (result *Collection, response *core.DetailedResponse, err error)
UpdateCollection : Update a collection
func (*DiscoveryV1) UpdateCollectionWithContext ¶
func (discovery *DiscoveryV1) UpdateCollectionWithContext(ctx context.Context, updateCollectionOptions *UpdateCollectionOptions) (result *Collection, response *core.DetailedResponse, err error)
UpdateCollectionWithContext is an alternate form of the UpdateCollection method which supports a Context parameter
func (*DiscoveryV1) UpdateConfiguration ¶
func (discovery *DiscoveryV1) UpdateConfiguration(updateConfigurationOptions *UpdateConfigurationOptions) (result *Configuration, response *core.DetailedResponse, err error)
UpdateConfiguration : Update a configuration Replaces an existing configuration.
- Completely replaces the original configuration.
- The **configuration_id**, **updated**, and **created** fields are accepted in the request, but they are ignored,
and an error is not generated. It is also acceptable for users to submit an updated configuration with none of the three properties.
- Documents are processed with a snapshot of the configuration as it was at the time the document was submitted to
be ingested. This means that already submitted documents will not see any updates made to the configuration.
func (*DiscoveryV1) UpdateConfigurationWithContext ¶
func (discovery *DiscoveryV1) UpdateConfigurationWithContext(ctx context.Context, updateConfigurationOptions *UpdateConfigurationOptions) (result *Configuration, response *core.DetailedResponse, err error)
UpdateConfigurationWithContext is an alternate form of the UpdateConfiguration method which supports a Context parameter
func (*DiscoveryV1) UpdateCredentials ¶
func (discovery *DiscoveryV1) UpdateCredentials(updateCredentialsOptions *UpdateCredentialsOptions) (result *Credentials, response *core.DetailedResponse, err error)
UpdateCredentials : Update credentials Updates an existing set of source credentials.
**Note:** All credentials are sent over an encrypted connection and encrypted at rest.
func (*DiscoveryV1) UpdateCredentialsWithContext ¶
func (discovery *DiscoveryV1) UpdateCredentialsWithContext(ctx context.Context, updateCredentialsOptions *UpdateCredentialsOptions) (result *Credentials, response *core.DetailedResponse, err error)
UpdateCredentialsWithContext is an alternate form of the UpdateCredentials method which supports a Context parameter
func (*DiscoveryV1) UpdateDocument ¶
func (discovery *DiscoveryV1) UpdateDocument(updateDocumentOptions *UpdateDocumentOptions) (result *DocumentAccepted, response *core.DetailedResponse, err error)
UpdateDocument : Update a document Replace an existing document or add a document with a specified **document_id**. Starts ingesting a document with optional metadata.
**Note:** When uploading a new document with this method it automatically replaces any document stored with the same **document_id** if it exists.
func (*DiscoveryV1) UpdateDocumentWithContext ¶
func (discovery *DiscoveryV1) UpdateDocumentWithContext(ctx context.Context, updateDocumentOptions *UpdateDocumentOptions) (result *DocumentAccepted, response *core.DetailedResponse, err error)
UpdateDocumentWithContext is an alternate form of the UpdateDocument method which supports a Context parameter
func (*DiscoveryV1) UpdateEnvironment ¶
func (discovery *DiscoveryV1) UpdateEnvironment(updateEnvironmentOptions *UpdateEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)
UpdateEnvironment : Update an environment Updates an environment. The environment's **name** and **description** parameters can be changed. You must specify a **name** for the environment.
func (*DiscoveryV1) UpdateEnvironmentWithContext ¶
func (discovery *DiscoveryV1) UpdateEnvironmentWithContext(ctx context.Context, updateEnvironmentOptions *UpdateEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)
UpdateEnvironmentWithContext is an alternate form of the UpdateEnvironment method which supports a Context parameter
func (*DiscoveryV1) UpdateTrainingExample ¶
func (discovery *DiscoveryV1) UpdateTrainingExample(updateTrainingExampleOptions *UpdateTrainingExampleOptions) (result *TrainingExample, response *core.DetailedResponse, err error)
UpdateTrainingExample : Change label or cross reference for example Changes the label or cross reference query for this training data example.
func (*DiscoveryV1) UpdateTrainingExampleWithContext ¶
func (discovery *DiscoveryV1) UpdateTrainingExampleWithContext(ctx context.Context, updateTrainingExampleOptions *UpdateTrainingExampleOptions) (result *TrainingExample, response *core.DetailedResponse, err error)
UpdateTrainingExampleWithContext is an alternate form of the UpdateTrainingExample method which supports a Context parameter
type DiscoveryV1Options ¶
type DiscoveryV1Options struct { ServiceName string URL string Authenticator core.Authenticator // Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is // `2019-04-30`. Version *string `validate:"required"` }
DiscoveryV1Options : Service options
type DiskUsage ¶
type DiskUsage struct { // Number of bytes within the environment's disk capacity that are currently used to store data. UsedBytes *int64 `json:"used_bytes,omitempty"` // Total number of bytes available in the environment's disk capacity. MaximumAllowedBytes *int64 `json:"maximum_allowed_bytes,omitempty"` }
DiskUsage : Summary of the disk usage statistics for the environment.
type DocumentAccepted ¶
type DocumentAccepted struct { // The unique identifier of the ingested document. DocumentID *string `json:"document_id,omitempty"` // Status of the document in the ingestion process. A status of `processing` is returned for documents that are // ingested with a *version* date before `2019-01-01`. The `pending` status is returned for all others. Status *string `json:"status,omitempty"` // Array of notices produced by the document-ingestion process. Notices []Notice `json:"notices,omitempty"` }
DocumentAccepted : Information returned after an uploaded document is accepted.
type DocumentCounts ¶
type DocumentCounts struct { // The total number of available documents in the collection. Available *int64 `json:"available,omitempty"` // The number of documents in the collection that are currently being processed. Processing *int64 `json:"processing,omitempty"` // The number of documents in the collection that failed to be ingested. Failed *int64 `json:"failed,omitempty"` // The number of documents that have been uploaded to the collection, but have not yet started processing. Pending *int64 `json:"pending,omitempty"` }
DocumentCounts : Object containing collection document count information.
type DocumentStatus ¶
type DocumentStatus struct { // The unique identifier of the document. DocumentID *string `json:"document_id" validate:"required"` // The unique identifier for the configuration. ConfigurationID *string `json:"configuration_id,omitempty"` // Status of the document in the ingestion process. Status *string `json:"status" validate:"required"` // Description of the document status. StatusDescription *string `json:"status_description" validate:"required"` // Name of the original source file (if available). Filename *string `json:"filename,omitempty"` // The type of the original source file. FileType *string `json:"file_type,omitempty"` // The SHA-1 hash of the original source file (formatted as a hexadecimal string). Sha1 *string `json:"sha1,omitempty"` // Array of notices produced by the document-ingestion process. Notices []Notice `json:"notices" validate:"required"` }
DocumentStatus : Status information about a submitted document.
type Enrichment ¶
type Enrichment struct { // Describes what the enrichment step does. Description *string `json:"description,omitempty"` // Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing // field. For example, if `text` is a top-level field with no sub-fields, `text.foo` is a valid destination but // `text.foo.bar` is not. DestinationField *string `json:"destination_field" validate:"required"` // Field to be enriched. // // Arrays can be specified as the **source_field** if the **enrichment** service for this enrichment is set to // `natural_language_undstanding`. SourceField *string `json:"source_field" validate:"required"` // Indicates that the enrichments will overwrite the destination_field field if it already exists. Overwrite *bool `json:"overwrite,omitempty"` // Name of the enrichment service to call. Current options are `natural_language_understanding` and `elements`. // // When using `natual_language_understanding`, the **options** object must contain Natural Language Understanding // options. // // When using `elements` the **options** object must contain Element Classification options. Additionally, when using // the `elements` enrichment the configuration specified and files ingested must meet all the criteria specified in // [the // documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-element-classification#element-classification). Enrichment *string `json:"enrichment" validate:"required"` // If true, then most errors generated during the enrichment process will be treated as warnings and will not cause the // document to fail processing. IgnoreDownstreamErrors *bool `json:"ignore_downstream_errors,omitempty"` // Options which are specific to a particular enrichment. Options *EnrichmentOptions `json:"options,omitempty"` }
Enrichment : Enrichment step to perform on the document. Each enrichment is performed on the specified field in the order that they are listed in the configuration.
type EnrichmentOptions ¶
type EnrichmentOptions struct { // Object containing Natural Language Understanding features to be used. Features *NluEnrichmentFeatures `json:"features,omitempty"` // ISO 639-1 code indicating the language to use for the analysis. This code overrides the automatic language detection // performed by the service. Valid codes are `ar` (Arabic), `en` (English), `fr` (French), `de` (German), `it` // (Italian), `pt` (Portuguese), `ru` (Russian), `es` (Spanish), and `sv` (Swedish). **Note:** Not all features support // all languages, automatic detection is recommended. Language *string `json:"language,omitempty"` // For use with `elements` enrichments only. The element extraction model to use. The only model available is // `contract`. Model *string `json:"model,omitempty"` }
EnrichmentOptions : Options which are specific to a particular enrichment.
type Environment ¶
type Environment struct { // Unique identifier for the environment. EnvironmentID *string `json:"environment_id,omitempty"` // Name that identifies the environment. Name *string `json:"name,omitempty"` // Description of the environment. Description *string `json:"description,omitempty"` // Creation date of the environment, in the format `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`. Created *strfmt.DateTime `json:"created,omitempty"` // Date of most recent environment update, in the format `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`. Updated *strfmt.DateTime `json:"updated,omitempty"` // Current status of the environment. `resizing` is displayed when a request to increase the environment size has been // made, but is still in the process of being completed. Status *string `json:"status,omitempty"` // If `true`, the environment contains read-only collections that are maintained by IBM. ReadOnly *bool `json:"read_only,omitempty"` // Current size of the environment. Size *string `json:"size,omitempty"` // The new size requested for this environment. Only returned when the environment *status* is `resizing`. // // *Note:* Querying and indexing can still be performed during an environment upsize. RequestedSize *string `json:"requested_size,omitempty"` // Details about the resource usage and capacity of the environment. IndexCapacity *IndexCapacity `json:"index_capacity,omitempty"` // Information about the Continuous Relevancy Training for this environment. SearchStatus *SearchStatus `json:"search_status,omitempty"` }
Environment : Details about an environment.
type EnvironmentDocuments ¶
type EnvironmentDocuments struct { // Number of documents indexed for the environment. Available *int64 `json:"available,omitempty"` // Total number of documents allowed in the environment's capacity. MaximumAllowed *int64 `json:"maximum_allowed,omitempty"` }
EnvironmentDocuments : Summary of the document usage statistics for the environment.
type EventData ¶
type EventData struct { // The **environment_id** associated with the query that the event is associated with. EnvironmentID *string `json:"environment_id" validate:"required"` // The session token that was returned as part of the query results that this event is associated with. SessionToken *string `json:"session_token" validate:"required"` // The optional timestamp for the event that was created. If not provided, the time that the event was created in the // log was used. ClientTimestamp *strfmt.DateTime `json:"client_timestamp,omitempty"` // The rank of the result item which the event is associated with. DisplayRank *int64 `json:"display_rank,omitempty"` // The **collection_id** of the document that this event is associated with. CollectionID *string `json:"collection_id" validate:"required"` // The **document_id** of the document that this event is associated with. DocumentID *string `json:"document_id" validate:"required"` // The query identifier stored in the log. The query and any events associated with that query are stored with the same // **query_id**. QueryID *string `json:"query_id,omitempty"` }
EventData : Query event data object.
type Expansion ¶
type Expansion struct { // A list of terms that will be expanded for this expansion. If specified, only the items in this list are expanded. InputTerms []string `json:"input_terms,omitempty"` // A list of terms that this expansion will be expanded to. If specified without **input_terms**, it also functions as // the input term list. ExpandedTerms []string `json:"expanded_terms" validate:"required"` }
Expansion : An expansion definition. Each object respresents one set of expandable strings. For example, you could have expansions for the word `hot` in one object, and expansions for the word `cold` in another.
type Expansions ¶
type Expansions struct { // An array of query expansion definitions. // // Each object in the **expansions** array represents a term or set of terms that will be expanded into other terms. // Each expansion object can be configured as bidirectional or unidirectional. Bidirectional means that all terms are // expanded to all other terms in the object. Unidirectional means that a set list of terms can be expanded into a // second list of terms. // // To create a bi-directional expansion specify an **expanded_terms** array. When found in a query, all items in the // **expanded_terms** array are then expanded to the other items in the same array. // // To create a uni-directional expansion, specify both an array of **input_terms** and an array of **expanded_terms**. // When items in the **input_terms** array are present in a query, they are expanded using the items listed in the // **expanded_terms** array. Expansions []Expansion `json:"expansions" validate:"required"` }
Expansions : The query expansion definitions for the specified collection.
type FederatedQueryNoticesOptions ¶
type FederatedQueryNoticesOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // A comma-separated list of collection IDs to be queried against. CollectionIds []string `json:"-" validate:"required"` // A cacheable query that excludes documents that don't mention the query content. Filter searches are better for // metadata-type searches and for assessing the concepts in the data set. Filter *string `json:"-"` // A query search returns all documents in your data set with full enrichments and full text, but with the most // relevant documents listed first. Query *string `json:"-"` // A natural language query that returns relevant documents by utilizing training data and natural language // understanding. NaturalLanguageQuery *string `json:"-"` // An aggregation search that returns an exact answer by combining query search with filters. Useful for applications // to build lists, tables, and time series. For a full list of possible aggregations, see the Query reference. Aggregation *string `json:"-"` // Number of results to return. The maximum for the **count** and **offset** values together in any one query is // **10000**. Count *int64 `json:"-"` // A comma-separated list of the portion of the document hierarchy to return. Return []string `json:"-"` // The number of query results to skip at the beginning. For example, if the total number of results that are returned // is 10 and the offset is 8, it returns the last two results. The maximum for the **count** and **offset** values // together in any one query is **10000**. Offset *int64 `json:"-"` // A comma-separated list of fields in the document to sort on. You can optionally specify a sort direction by // prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no // prefix is specified. Sort []string `json:"-"` // When true, a highlight field is returned for each result which contains the fields which match the query with // `<em></em>` tags around the matching query terms. Highlight *bool `json:"-"` // When specified, duplicate results based on the field specified are removed from the returned results. Duplicate // comparison is limited to the current query only, **offset** is not considered. This parameter is currently Beta // functionality. DeduplicateField *string `json:"-"` // When `true`, results are returned based on their similarity to the document IDs specified in the // **similar.document_ids** parameter. Similar *bool `json:"-"` // A comma-separated list of document IDs to find similar documents. // // **Tip:** Include the **natural_language_query** parameter to expand the scope of the document similarity search with // the natural language query. Other query parameters, such as **filter** and **query**, are subsequently applied and // reduce the scope. SimilarDocumentIds []string `json:"-"` // A comma-separated list of field names that are used as a basis for comparison to identify similar documents. If not // specified, the entire document is used for comparison. SimilarFields []string `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
FederatedQueryNoticesOptions : The FederatedQueryNotices options.
func (*FederatedQueryNoticesOptions) SetAggregation ¶
func (_options *FederatedQueryNoticesOptions) SetAggregation(aggregation string) *FederatedQueryNoticesOptions
SetAggregation : Allow user to set Aggregation
func (*FederatedQueryNoticesOptions) SetCollectionIds ¶
func (_options *FederatedQueryNoticesOptions) SetCollectionIds(collectionIds []string) *FederatedQueryNoticesOptions
SetCollectionIds : Allow user to set CollectionIds
func (*FederatedQueryNoticesOptions) SetCount ¶
func (_options *FederatedQueryNoticesOptions) SetCount(count int64) *FederatedQueryNoticesOptions
SetCount : Allow user to set Count
func (*FederatedQueryNoticesOptions) SetDeduplicateField ¶
func (_options *FederatedQueryNoticesOptions) SetDeduplicateField(deduplicateField string) *FederatedQueryNoticesOptions
SetDeduplicateField : Allow user to set DeduplicateField
func (*FederatedQueryNoticesOptions) SetEnvironmentID ¶
func (_options *FederatedQueryNoticesOptions) SetEnvironmentID(environmentID string) *FederatedQueryNoticesOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*FederatedQueryNoticesOptions) SetFilter ¶
func (_options *FederatedQueryNoticesOptions) SetFilter(filter string) *FederatedQueryNoticesOptions
SetFilter : Allow user to set Filter
func (*FederatedQueryNoticesOptions) SetHeaders ¶
func (options *FederatedQueryNoticesOptions) SetHeaders(param map[string]string) *FederatedQueryNoticesOptions
SetHeaders : Allow user to set Headers
func (*FederatedQueryNoticesOptions) SetHighlight ¶
func (_options *FederatedQueryNoticesOptions) SetHighlight(highlight bool) *FederatedQueryNoticesOptions
SetHighlight : Allow user to set Highlight
func (*FederatedQueryNoticesOptions) SetNaturalLanguageQuery ¶
func (_options *FederatedQueryNoticesOptions) SetNaturalLanguageQuery(naturalLanguageQuery string) *FederatedQueryNoticesOptions
SetNaturalLanguageQuery : Allow user to set NaturalLanguageQuery
func (*FederatedQueryNoticesOptions) SetOffset ¶
func (_options *FederatedQueryNoticesOptions) SetOffset(offset int64) *FederatedQueryNoticesOptions
SetOffset : Allow user to set Offset
func (*FederatedQueryNoticesOptions) SetQuery ¶
func (_options *FederatedQueryNoticesOptions) SetQuery(query string) *FederatedQueryNoticesOptions
SetQuery : Allow user to set Query
func (*FederatedQueryNoticesOptions) SetReturn ¶
func (_options *FederatedQueryNoticesOptions) SetReturn(returnVar []string) *FederatedQueryNoticesOptions
SetReturn : Allow user to set Return
func (*FederatedQueryNoticesOptions) SetSimilar ¶
func (_options *FederatedQueryNoticesOptions) SetSimilar(similar bool) *FederatedQueryNoticesOptions
SetSimilar : Allow user to set Similar
func (*FederatedQueryNoticesOptions) SetSimilarDocumentIds ¶
func (_options *FederatedQueryNoticesOptions) SetSimilarDocumentIds(similarDocumentIds []string) *FederatedQueryNoticesOptions
SetSimilarDocumentIds : Allow user to set SimilarDocumentIds
func (*FederatedQueryNoticesOptions) SetSimilarFields ¶
func (_options *FederatedQueryNoticesOptions) SetSimilarFields(similarFields []string) *FederatedQueryNoticesOptions
SetSimilarFields : Allow user to set SimilarFields
func (*FederatedQueryNoticesOptions) SetSort ¶
func (_options *FederatedQueryNoticesOptions) SetSort(sort []string) *FederatedQueryNoticesOptions
SetSort : Allow user to set Sort
type FederatedQueryOptions ¶
type FederatedQueryOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // A comma-separated list of collection IDs to be queried against. CollectionIds *string `json:"collection_ids" validate:"required"` // A cacheable query that excludes documents that don't mention the query content. Filter searches are better for // metadata-type searches and for assessing the concepts in the data set. Filter *string `json:"filter,omitempty"` // A query search returns all documents in your data set with full enrichments and full text, but with the most // relevant documents listed first. Use a query search when you want to find the most relevant search results. Query *string `json:"query,omitempty"` // A natural language query that returns relevant documents by utilizing training data and natural language // understanding. NaturalLanguageQuery *string `json:"natural_language_query,omitempty"` // A passages query that returns the most relevant passages from the results. Passages *bool `json:"passages,omitempty"` // An aggregation search that returns an exact answer by combining query search with filters. Useful for applications // to build lists, tables, and time series. For a full list of possible aggregations, see the Query reference. Aggregation *string `json:"aggregation,omitempty"` // Number of results to return. Count *int64 `json:"count,omitempty"` // A comma-separated list of the portion of the document hierarchy to return. Return *string `json:"return,omitempty"` // The number of query results to skip at the beginning. For example, if the total number of results that are returned // is 10 and the offset is 8, it returns the last two results. Offset *int64 `json:"offset,omitempty"` // A comma-separated list of fields in the document to sort on. You can optionally specify a sort direction by // prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no // prefix is specified. This parameter cannot be used in the same query as the **bias** parameter. Sort *string `json:"sort,omitempty"` // When true, a highlight field is returned for each result which contains the fields which match the query with // `<em></em>` tags around the matching query terms. Highlight *bool `json:"highlight,omitempty"` // A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all top-level // fields are included. PassagesFields *string `json:"passages.fields,omitempty"` // The maximum number of passages to return. The search returns fewer passages if the requested total is not found. The // default is `10`. The maximum is `100`. PassagesCount *int64 `json:"passages.count,omitempty"` // The approximate number of characters that any one passage will have. PassagesCharacters *int64 `json:"passages.characters,omitempty"` // When `true`, and used with a Watson Discovery News collection, duplicate results (based on the contents of the // **title** field) are removed. Duplicate comparison is limited to the current query only; **offset** is not // considered. This parameter is currently Beta functionality. Deduplicate *bool `json:"deduplicate,omitempty"` // When specified, duplicate results based on the field specified are removed from the returned results. Duplicate // comparison is limited to the current query only, **offset** is not considered. This parameter is currently Beta // functionality. DeduplicateField *string `json:"deduplicate.field,omitempty"` // When `true`, results are returned based on their similarity to the document IDs specified in the // **similar.document_ids** parameter. Similar *bool `json:"similar,omitempty"` // A comma-separated list of document IDs to find similar documents. // // **Tip:** Include the **natural_language_query** parameter to expand the scope of the document similarity search with // the natural language query. Other query parameters, such as **filter** and **query**, are subsequently applied and // reduce the scope. SimilarDocumentIds *string `json:"similar.document_ids,omitempty"` // A comma-separated list of field names that are used as a basis for comparison to identify similar documents. If not // specified, the entire document is used for comparison. SimilarFields *string `json:"similar.fields,omitempty"` // Field which the returned results will be biased against. The specified field must be either a **date** or **number** // format. When a **date** type field is specified returned results are biased towards field values closer to the // current date. When a **number** type field is specified, returned results are biased towards higher field values. // This parameter cannot be used in the same query as the **sort** parameter. Bias *string `json:"bias,omitempty"` // If `true`, queries are not stored in the Discovery **Logs** endpoint. XWatsonLoggingOptOut *bool `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
FederatedQueryOptions : The FederatedQuery options.
func (*FederatedQueryOptions) SetAggregation ¶
func (_options *FederatedQueryOptions) SetAggregation(aggregation string) *FederatedQueryOptions
SetAggregation : Allow user to set Aggregation
func (*FederatedQueryOptions) SetBias ¶
func (_options *FederatedQueryOptions) SetBias(bias string) *FederatedQueryOptions
SetBias : Allow user to set Bias
func (*FederatedQueryOptions) SetCollectionIds ¶
func (_options *FederatedQueryOptions) SetCollectionIds(collectionIds string) *FederatedQueryOptions
SetCollectionIds : Allow user to set CollectionIds
func (*FederatedQueryOptions) SetCount ¶
func (_options *FederatedQueryOptions) SetCount(count int64) *FederatedQueryOptions
SetCount : Allow user to set Count
func (*FederatedQueryOptions) SetDeduplicate ¶
func (_options *FederatedQueryOptions) SetDeduplicate(deduplicate bool) *FederatedQueryOptions
SetDeduplicate : Allow user to set Deduplicate
func (*FederatedQueryOptions) SetDeduplicateField ¶
func (_options *FederatedQueryOptions) SetDeduplicateField(deduplicateField string) *FederatedQueryOptions
SetDeduplicateField : Allow user to set DeduplicateField
func (*FederatedQueryOptions) SetEnvironmentID ¶
func (_options *FederatedQueryOptions) SetEnvironmentID(environmentID string) *FederatedQueryOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*FederatedQueryOptions) SetFilter ¶
func (_options *FederatedQueryOptions) SetFilter(filter string) *FederatedQueryOptions
SetFilter : Allow user to set Filter
func (*FederatedQueryOptions) SetHeaders ¶
func (options *FederatedQueryOptions) SetHeaders(param map[string]string) *FederatedQueryOptions
SetHeaders : Allow user to set Headers
func (*FederatedQueryOptions) SetHighlight ¶
func (_options *FederatedQueryOptions) SetHighlight(highlight bool) *FederatedQueryOptions
SetHighlight : Allow user to set Highlight
func (*FederatedQueryOptions) SetNaturalLanguageQuery ¶
func (_options *FederatedQueryOptions) SetNaturalLanguageQuery(naturalLanguageQuery string) *FederatedQueryOptions
SetNaturalLanguageQuery : Allow user to set NaturalLanguageQuery
func (*FederatedQueryOptions) SetOffset ¶
func (_options *FederatedQueryOptions) SetOffset(offset int64) *FederatedQueryOptions
SetOffset : Allow user to set Offset
func (*FederatedQueryOptions) SetPassages ¶
func (_options *FederatedQueryOptions) SetPassages(passages bool) *FederatedQueryOptions
SetPassages : Allow user to set Passages
func (*FederatedQueryOptions) SetPassagesCharacters ¶
func (_options *FederatedQueryOptions) SetPassagesCharacters(passagesCharacters int64) *FederatedQueryOptions
SetPassagesCharacters : Allow user to set PassagesCharacters
func (*FederatedQueryOptions) SetPassagesCount ¶
func (_options *FederatedQueryOptions) SetPassagesCount(passagesCount int64) *FederatedQueryOptions
SetPassagesCount : Allow user to set PassagesCount
func (*FederatedQueryOptions) SetPassagesFields ¶
func (_options *FederatedQueryOptions) SetPassagesFields(passagesFields string) *FederatedQueryOptions
SetPassagesFields : Allow user to set PassagesFields
func (*FederatedQueryOptions) SetQuery ¶
func (_options *FederatedQueryOptions) SetQuery(query string) *FederatedQueryOptions
SetQuery : Allow user to set Query
func (*FederatedQueryOptions) SetReturn ¶
func (_options *FederatedQueryOptions) SetReturn(returnVar string) *FederatedQueryOptions
SetReturn : Allow user to set Return
func (*FederatedQueryOptions) SetSimilar ¶
func (_options *FederatedQueryOptions) SetSimilar(similar bool) *FederatedQueryOptions
SetSimilar : Allow user to set Similar
func (*FederatedQueryOptions) SetSimilarDocumentIds ¶
func (_options *FederatedQueryOptions) SetSimilarDocumentIds(similarDocumentIds string) *FederatedQueryOptions
SetSimilarDocumentIds : Allow user to set SimilarDocumentIds
func (*FederatedQueryOptions) SetSimilarFields ¶
func (_options *FederatedQueryOptions) SetSimilarFields(similarFields string) *FederatedQueryOptions
SetSimilarFields : Allow user to set SimilarFields
func (*FederatedQueryOptions) SetSort ¶
func (_options *FederatedQueryOptions) SetSort(sort string) *FederatedQueryOptions
SetSort : Allow user to set Sort
func (*FederatedQueryOptions) SetXWatsonLoggingOptOut ¶
func (_options *FederatedQueryOptions) SetXWatsonLoggingOptOut(xWatsonLoggingOptOut bool) *FederatedQueryOptions
SetXWatsonLoggingOptOut : Allow user to set XWatsonLoggingOptOut
type Field ¶
type Field struct { // The name of the field. Field *string `json:"field,omitempty"` // The type of the field. Type *string `json:"type,omitempty"` }
Field : Object containing field details.
type Filter ¶
type Filter struct { // The type of aggregation command used. For example: term, filter, max, min, etc. Type *string `json:"type,omitempty"` // Array of aggregation results. Results []AggregationResult `json:"results,omitempty"` // Number of matching results. MatchingResults *int64 `json:"matching_results,omitempty"` // Aggregations returned by Discovery. Aggregations []QueryAggregationIntf `json:"aggregations,omitempty"` // The match the aggregated results queried for. Match *string `json:"match,omitempty"` }
Filter : Filter struct This model "extends" QueryAggregation
type FontSetting ¶
type FontSetting struct { // The HTML heading level that any content with the matching font is converted to. Level *int64 `json:"level,omitempty"` // The minimum size of the font to match. MinSize *int64 `json:"min_size,omitempty"` // The maximum size of the font to match. MaxSize *int64 `json:"max_size,omitempty"` // When `true`, the font is matched if it is bold. Bold *bool `json:"bold,omitempty"` // When `true`, the font is matched if it is italic. Italic *bool `json:"italic,omitempty"` // The name of the font. Name *string `json:"name,omitempty"` }
FontSetting : Font matching configuration.
type Gateway ¶
type Gateway struct { // The gateway ID of the gateway. GatewayID *string `json:"gateway_id,omitempty"` // The user defined name of the gateway. Name *string `json:"name,omitempty"` // The current status of the gateway. `connected` means the gateway is connected to the remotly installed gateway. // `idle` means this gateway is not currently in use. Status *string `json:"status,omitempty"` // The generated **token** for this gateway. The value of this field is used when configuring the remotly installed // gateway. Token *string `json:"token,omitempty"` // The generated **token_id** for this gateway. The value of this field is used when configuring the remotly installed // gateway. TokenID *string `json:"token_id,omitempty"` }
Gateway : Object describing a specific gateway.
type GatewayDelete ¶
type GatewayDelete struct { // The gateway ID of the deleted gateway. GatewayID *string `json:"gateway_id,omitempty"` // The status of the request. Status *string `json:"status,omitempty"` }
GatewayDelete : Gatway deletion confirmation.
type GatewayList ¶
type GatewayList struct { // Array of configured gateway connections. Gateways []Gateway `json:"gateways,omitempty"` }
GatewayList : Object containing gateways array.
type GetAutocompletionOptions ¶
type GetAutocompletionOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // The prefix to use for autocompletion. For example, the prefix `Ho` could autocomplete to `hot`, `housing`, or `how`. Prefix *string `json:"-" validate:"required"` // The field in the result documents that autocompletion suggestions are identified from. Field *string `json:"-"` // The number of autocompletion suggestions to return. Count *int64 `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
GetAutocompletionOptions : The GetAutocompletion options.
func (*GetAutocompletionOptions) SetCollectionID ¶
func (_options *GetAutocompletionOptions) SetCollectionID(collectionID string) *GetAutocompletionOptions
SetCollectionID : Allow user to set CollectionID
func (*GetAutocompletionOptions) SetCount ¶
func (_options *GetAutocompletionOptions) SetCount(count int64) *GetAutocompletionOptions
SetCount : Allow user to set Count
func (*GetAutocompletionOptions) SetEnvironmentID ¶
func (_options *GetAutocompletionOptions) SetEnvironmentID(environmentID string) *GetAutocompletionOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*GetAutocompletionOptions) SetField ¶
func (_options *GetAutocompletionOptions) SetField(field string) *GetAutocompletionOptions
SetField : Allow user to set Field
func (*GetAutocompletionOptions) SetHeaders ¶
func (options *GetAutocompletionOptions) SetHeaders(param map[string]string) *GetAutocompletionOptions
SetHeaders : Allow user to set Headers
func (*GetAutocompletionOptions) SetPrefix ¶
func (_options *GetAutocompletionOptions) SetPrefix(prefix string) *GetAutocompletionOptions
SetPrefix : Allow user to set Prefix
type GetCollectionOptions ¶
type GetCollectionOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
GetCollectionOptions : The GetCollection options.
func (*GetCollectionOptions) SetCollectionID ¶
func (_options *GetCollectionOptions) SetCollectionID(collectionID string) *GetCollectionOptions
SetCollectionID : Allow user to set CollectionID
func (*GetCollectionOptions) SetEnvironmentID ¶
func (_options *GetCollectionOptions) SetEnvironmentID(environmentID string) *GetCollectionOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*GetCollectionOptions) SetHeaders ¶
func (options *GetCollectionOptions) SetHeaders(param map[string]string) *GetCollectionOptions
SetHeaders : Allow user to set Headers
type GetConfigurationOptions ¶
type GetConfigurationOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the configuration. ConfigurationID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
GetConfigurationOptions : The GetConfiguration options.
func (*GetConfigurationOptions) SetConfigurationID ¶
func (_options *GetConfigurationOptions) SetConfigurationID(configurationID string) *GetConfigurationOptions
SetConfigurationID : Allow user to set ConfigurationID
func (*GetConfigurationOptions) SetEnvironmentID ¶
func (_options *GetConfigurationOptions) SetEnvironmentID(environmentID string) *GetConfigurationOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*GetConfigurationOptions) SetHeaders ¶
func (options *GetConfigurationOptions) SetHeaders(param map[string]string) *GetConfigurationOptions
SetHeaders : Allow user to set Headers
type GetCredentialsOptions ¶
type GetCredentialsOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The unique identifier for a set of source credentials. CredentialID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
GetCredentialsOptions : The GetCredentials options.
func (*GetCredentialsOptions) SetCredentialID ¶
func (_options *GetCredentialsOptions) SetCredentialID(credentialID string) *GetCredentialsOptions
SetCredentialID : Allow user to set CredentialID
func (*GetCredentialsOptions) SetEnvironmentID ¶
func (_options *GetCredentialsOptions) SetEnvironmentID(environmentID string) *GetCredentialsOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*GetCredentialsOptions) SetHeaders ¶
func (options *GetCredentialsOptions) SetHeaders(param map[string]string) *GetCredentialsOptions
SetHeaders : Allow user to set Headers
type GetDocumentStatusOptions ¶
type GetDocumentStatusOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // The ID of the document. DocumentID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
GetDocumentStatusOptions : The GetDocumentStatus options.
func (*GetDocumentStatusOptions) SetCollectionID ¶
func (_options *GetDocumentStatusOptions) SetCollectionID(collectionID string) *GetDocumentStatusOptions
SetCollectionID : Allow user to set CollectionID
func (*GetDocumentStatusOptions) SetDocumentID ¶
func (_options *GetDocumentStatusOptions) SetDocumentID(documentID string) *GetDocumentStatusOptions
SetDocumentID : Allow user to set DocumentID
func (*GetDocumentStatusOptions) SetEnvironmentID ¶
func (_options *GetDocumentStatusOptions) SetEnvironmentID(environmentID string) *GetDocumentStatusOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*GetDocumentStatusOptions) SetHeaders ¶
func (options *GetDocumentStatusOptions) SetHeaders(param map[string]string) *GetDocumentStatusOptions
SetHeaders : Allow user to set Headers
type GetEnvironmentOptions ¶
type GetEnvironmentOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
GetEnvironmentOptions : The GetEnvironment options.
func (*GetEnvironmentOptions) SetEnvironmentID ¶
func (_options *GetEnvironmentOptions) SetEnvironmentID(environmentID string) *GetEnvironmentOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*GetEnvironmentOptions) SetHeaders ¶
func (options *GetEnvironmentOptions) SetHeaders(param map[string]string) *GetEnvironmentOptions
SetHeaders : Allow user to set Headers
type GetGatewayOptions ¶
type GetGatewayOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The requested gateway ID. GatewayID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
GetGatewayOptions : The GetGateway options.
func (*GetGatewayOptions) SetEnvironmentID ¶
func (_options *GetGatewayOptions) SetEnvironmentID(environmentID string) *GetGatewayOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*GetGatewayOptions) SetGatewayID ¶
func (_options *GetGatewayOptions) SetGatewayID(gatewayID string) *GetGatewayOptions
SetGatewayID : Allow user to set GatewayID
func (*GetGatewayOptions) SetHeaders ¶
func (options *GetGatewayOptions) SetHeaders(param map[string]string) *GetGatewayOptions
SetHeaders : Allow user to set Headers
type GetMetricsEventRateOptions ¶
type GetMetricsEventRateOptions struct { // Metric is computed from data recorded after this timestamp; must be in `YYYY-MM-DDThh:mm:ssZ` format. StartTime *strfmt.DateTime `json:"-"` // Metric is computed from data recorded before this timestamp; must be in `YYYY-MM-DDThh:mm:ssZ` format. EndTime *strfmt.DateTime `json:"-"` // The type of result to consider when calculating the metric. ResultType *string `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
GetMetricsEventRateOptions : The GetMetricsEventRate options.
func (*GetMetricsEventRateOptions) SetEndTime ¶
func (_options *GetMetricsEventRateOptions) SetEndTime(endTime *strfmt.DateTime) *GetMetricsEventRateOptions
SetEndTime : Allow user to set EndTime
func (*GetMetricsEventRateOptions) SetHeaders ¶
func (options *GetMetricsEventRateOptions) SetHeaders(param map[string]string) *GetMetricsEventRateOptions
SetHeaders : Allow user to set Headers
func (*GetMetricsEventRateOptions) SetResultType ¶
func (_options *GetMetricsEventRateOptions) SetResultType(resultType string) *GetMetricsEventRateOptions
SetResultType : Allow user to set ResultType
func (*GetMetricsEventRateOptions) SetStartTime ¶
func (_options *GetMetricsEventRateOptions) SetStartTime(startTime *strfmt.DateTime) *GetMetricsEventRateOptions
SetStartTime : Allow user to set StartTime
type GetMetricsQueryEventOptions ¶
type GetMetricsQueryEventOptions struct { // Metric is computed from data recorded after this timestamp; must be in `YYYY-MM-DDThh:mm:ssZ` format. StartTime *strfmt.DateTime `json:"-"` // Metric is computed from data recorded before this timestamp; must be in `YYYY-MM-DDThh:mm:ssZ` format. EndTime *strfmt.DateTime `json:"-"` // The type of result to consider when calculating the metric. ResultType *string `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
GetMetricsQueryEventOptions : The GetMetricsQueryEvent options.
func (*GetMetricsQueryEventOptions) SetEndTime ¶
func (_options *GetMetricsQueryEventOptions) SetEndTime(endTime *strfmt.DateTime) *GetMetricsQueryEventOptions
SetEndTime : Allow user to set EndTime
func (*GetMetricsQueryEventOptions) SetHeaders ¶
func (options *GetMetricsQueryEventOptions) SetHeaders(param map[string]string) *GetMetricsQueryEventOptions
SetHeaders : Allow user to set Headers
func (*GetMetricsQueryEventOptions) SetResultType ¶
func (_options *GetMetricsQueryEventOptions) SetResultType(resultType string) *GetMetricsQueryEventOptions
SetResultType : Allow user to set ResultType
func (*GetMetricsQueryEventOptions) SetStartTime ¶
func (_options *GetMetricsQueryEventOptions) SetStartTime(startTime *strfmt.DateTime) *GetMetricsQueryEventOptions
SetStartTime : Allow user to set StartTime
type GetMetricsQueryNoResultsOptions ¶
type GetMetricsQueryNoResultsOptions struct { // Metric is computed from data recorded after this timestamp; must be in `YYYY-MM-DDThh:mm:ssZ` format. StartTime *strfmt.DateTime `json:"-"` // Metric is computed from data recorded before this timestamp; must be in `YYYY-MM-DDThh:mm:ssZ` format. EndTime *strfmt.DateTime `json:"-"` // The type of result to consider when calculating the metric. ResultType *string `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
GetMetricsQueryNoResultsOptions : The GetMetricsQueryNoResults options.
func (*GetMetricsQueryNoResultsOptions) SetEndTime ¶
func (_options *GetMetricsQueryNoResultsOptions) SetEndTime(endTime *strfmt.DateTime) *GetMetricsQueryNoResultsOptions
SetEndTime : Allow user to set EndTime
func (*GetMetricsQueryNoResultsOptions) SetHeaders ¶
func (options *GetMetricsQueryNoResultsOptions) SetHeaders(param map[string]string) *GetMetricsQueryNoResultsOptions
SetHeaders : Allow user to set Headers
func (*GetMetricsQueryNoResultsOptions) SetResultType ¶
func (_options *GetMetricsQueryNoResultsOptions) SetResultType(resultType string) *GetMetricsQueryNoResultsOptions
SetResultType : Allow user to set ResultType
func (*GetMetricsQueryNoResultsOptions) SetStartTime ¶
func (_options *GetMetricsQueryNoResultsOptions) SetStartTime(startTime *strfmt.DateTime) *GetMetricsQueryNoResultsOptions
SetStartTime : Allow user to set StartTime
type GetMetricsQueryOptions ¶
type GetMetricsQueryOptions struct { // Metric is computed from data recorded after this timestamp; must be in `YYYY-MM-DDThh:mm:ssZ` format. StartTime *strfmt.DateTime `json:"-"` // Metric is computed from data recorded before this timestamp; must be in `YYYY-MM-DDThh:mm:ssZ` format. EndTime *strfmt.DateTime `json:"-"` // The type of result to consider when calculating the metric. ResultType *string `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
GetMetricsQueryOptions : The GetMetricsQuery options.
func (*GetMetricsQueryOptions) SetEndTime ¶
func (_options *GetMetricsQueryOptions) SetEndTime(endTime *strfmt.DateTime) *GetMetricsQueryOptions
SetEndTime : Allow user to set EndTime
func (*GetMetricsQueryOptions) SetHeaders ¶
func (options *GetMetricsQueryOptions) SetHeaders(param map[string]string) *GetMetricsQueryOptions
SetHeaders : Allow user to set Headers
func (*GetMetricsQueryOptions) SetResultType ¶
func (_options *GetMetricsQueryOptions) SetResultType(resultType string) *GetMetricsQueryOptions
SetResultType : Allow user to set ResultType
func (*GetMetricsQueryOptions) SetStartTime ¶
func (_options *GetMetricsQueryOptions) SetStartTime(startTime *strfmt.DateTime) *GetMetricsQueryOptions
SetStartTime : Allow user to set StartTime
type GetMetricsQueryTokenEventOptions ¶
type GetMetricsQueryTokenEventOptions struct { // Number of results to return. The maximum for the **count** and **offset** values together in any one query is // **10000**. Count *int64 `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
GetMetricsQueryTokenEventOptions : The GetMetricsQueryTokenEvent options.
func (*GetMetricsQueryTokenEventOptions) SetCount ¶
func (_options *GetMetricsQueryTokenEventOptions) SetCount(count int64) *GetMetricsQueryTokenEventOptions
SetCount : Allow user to set Count
func (*GetMetricsQueryTokenEventOptions) SetHeaders ¶
func (options *GetMetricsQueryTokenEventOptions) SetHeaders(param map[string]string) *GetMetricsQueryTokenEventOptions
SetHeaders : Allow user to set Headers
type GetStopwordListStatusOptions ¶
type GetStopwordListStatusOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
GetStopwordListStatusOptions : The GetStopwordListStatus options.
func (*GetStopwordListStatusOptions) SetCollectionID ¶
func (_options *GetStopwordListStatusOptions) SetCollectionID(collectionID string) *GetStopwordListStatusOptions
SetCollectionID : Allow user to set CollectionID
func (*GetStopwordListStatusOptions) SetEnvironmentID ¶
func (_options *GetStopwordListStatusOptions) SetEnvironmentID(environmentID string) *GetStopwordListStatusOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*GetStopwordListStatusOptions) SetHeaders ¶
func (options *GetStopwordListStatusOptions) SetHeaders(param map[string]string) *GetStopwordListStatusOptions
SetHeaders : Allow user to set Headers
type GetTokenizationDictionaryStatusOptions ¶
type GetTokenizationDictionaryStatusOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
GetTokenizationDictionaryStatusOptions : The GetTokenizationDictionaryStatus options.
func (*GetTokenizationDictionaryStatusOptions) SetCollectionID ¶
func (_options *GetTokenizationDictionaryStatusOptions) SetCollectionID(collectionID string) *GetTokenizationDictionaryStatusOptions
SetCollectionID : Allow user to set CollectionID
func (*GetTokenizationDictionaryStatusOptions) SetEnvironmentID ¶
func (_options *GetTokenizationDictionaryStatusOptions) SetEnvironmentID(environmentID string) *GetTokenizationDictionaryStatusOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*GetTokenizationDictionaryStatusOptions) SetHeaders ¶
func (options *GetTokenizationDictionaryStatusOptions) SetHeaders(param map[string]string) *GetTokenizationDictionaryStatusOptions
SetHeaders : Allow user to set Headers
type GetTrainingDataOptions ¶
type GetTrainingDataOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // The ID of the query used for training. QueryID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
GetTrainingDataOptions : The GetTrainingData options.
func (*GetTrainingDataOptions) SetCollectionID ¶
func (_options *GetTrainingDataOptions) SetCollectionID(collectionID string) *GetTrainingDataOptions
SetCollectionID : Allow user to set CollectionID
func (*GetTrainingDataOptions) SetEnvironmentID ¶
func (_options *GetTrainingDataOptions) SetEnvironmentID(environmentID string) *GetTrainingDataOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*GetTrainingDataOptions) SetHeaders ¶
func (options *GetTrainingDataOptions) SetHeaders(param map[string]string) *GetTrainingDataOptions
SetHeaders : Allow user to set Headers
func (*GetTrainingDataOptions) SetQueryID ¶
func (_options *GetTrainingDataOptions) SetQueryID(queryID string) *GetTrainingDataOptions
SetQueryID : Allow user to set QueryID
type GetTrainingExampleOptions ¶
type GetTrainingExampleOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // The ID of the query used for training. QueryID *string `json:"-" validate:"required,ne="` // The ID of the document as it is indexed. ExampleID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
GetTrainingExampleOptions : The GetTrainingExample options.
func (*GetTrainingExampleOptions) SetCollectionID ¶
func (_options *GetTrainingExampleOptions) SetCollectionID(collectionID string) *GetTrainingExampleOptions
SetCollectionID : Allow user to set CollectionID
func (*GetTrainingExampleOptions) SetEnvironmentID ¶
func (_options *GetTrainingExampleOptions) SetEnvironmentID(environmentID string) *GetTrainingExampleOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*GetTrainingExampleOptions) SetExampleID ¶
func (_options *GetTrainingExampleOptions) SetExampleID(exampleID string) *GetTrainingExampleOptions
SetExampleID : Allow user to set ExampleID
func (*GetTrainingExampleOptions) SetHeaders ¶
func (options *GetTrainingExampleOptions) SetHeaders(param map[string]string) *GetTrainingExampleOptions
SetHeaders : Allow user to set Headers
func (*GetTrainingExampleOptions) SetQueryID ¶
func (_options *GetTrainingExampleOptions) SetQueryID(queryID string) *GetTrainingExampleOptions
SetQueryID : Allow user to set QueryID
type HTMLSettings ¶
type HTMLSettings struct { // Array of HTML tags that are excluded completely. ExcludeTagsCompletely []string `json:"exclude_tags_completely,omitempty"` // Array of HTML tags which are excluded but still retain content. ExcludeTagsKeepContent []string `json:"exclude_tags_keep_content,omitempty"` // Object containing an array of XPaths. KeepContent *XPathPatterns `json:"keep_content,omitempty"` // Object containing an array of XPaths. ExcludeContent *XPathPatterns `json:"exclude_content,omitempty"` // An array of HTML tag attributes to keep in the converted document. KeepTagAttributes []string `json:"keep_tag_attributes,omitempty"` // Array of HTML tag attributes to exclude. ExcludeTagAttributes []string `json:"exclude_tag_attributes,omitempty"` }
HTMLSettings : A list of HTML conversion settings.
type Histogram ¶
type Histogram struct { // The type of aggregation command used. For example: term, filter, max, min, etc. Type *string `json:"type,omitempty"` // Array of aggregation results. Results []AggregationResult `json:"results,omitempty"` // Number of matching results. MatchingResults *int64 `json:"matching_results,omitempty"` // Aggregations returned by Discovery. Aggregations []QueryAggregationIntf `json:"aggregations,omitempty"` // The field where the aggregation is located in the document. Field *string `json:"field,omitempty"` // Interval of the aggregation. (For 'histogram' type). Interval *int64 `json:"interval,omitempty"` }
Histogram : Histogram struct This model "extends" QueryAggregation
type IndexCapacity ¶
type IndexCapacity struct { // Summary of the document usage statistics for the environment. Documents *EnvironmentDocuments `json:"documents,omitempty"` // Summary of the disk usage statistics for the environment. DiskUsage *DiskUsage `json:"disk_usage,omitempty"` // Summary of the collection usage in the environment. Collections *CollectionUsage `json:"collections,omitempty"` }
IndexCapacity : Details about the resource usage and capacity of the environment.
type ListCollectionFieldsOptions ¶
type ListCollectionFieldsOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
ListCollectionFieldsOptions : The ListCollectionFields options.
func (*ListCollectionFieldsOptions) SetCollectionID ¶
func (_options *ListCollectionFieldsOptions) SetCollectionID(collectionID string) *ListCollectionFieldsOptions
SetCollectionID : Allow user to set CollectionID
func (*ListCollectionFieldsOptions) SetEnvironmentID ¶
func (_options *ListCollectionFieldsOptions) SetEnvironmentID(environmentID string) *ListCollectionFieldsOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*ListCollectionFieldsOptions) SetHeaders ¶
func (options *ListCollectionFieldsOptions) SetHeaders(param map[string]string) *ListCollectionFieldsOptions
SetHeaders : Allow user to set Headers
type ListCollectionFieldsResponse ¶
type ListCollectionFieldsResponse struct { // An array containing information about each field in the collections. Fields []Field `json:"fields,omitempty"` }
ListCollectionFieldsResponse : The list of fetched fields.
The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations.
Fields which contain nested JSON objects are assigned a type of "nested".
Fields which belong to a nested object are prefixed with `.properties` (for example,
`warnings.properties.severity` means that the `warnings` object has a property called `severity`).
- Fields returned from the News collection are prefixed with `v{N}-fullnews-t3-{YEAR}.mappings` (for example,
`v5-fullnews-t3-2016.mappings.text.properties.author`).
type ListCollectionsOptions ¶
type ListCollectionsOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // Find collections with the given name. Name *string `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
ListCollectionsOptions : The ListCollections options.
func (*ListCollectionsOptions) SetEnvironmentID ¶
func (_options *ListCollectionsOptions) SetEnvironmentID(environmentID string) *ListCollectionsOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*ListCollectionsOptions) SetHeaders ¶
func (options *ListCollectionsOptions) SetHeaders(param map[string]string) *ListCollectionsOptions
SetHeaders : Allow user to set Headers
func (*ListCollectionsOptions) SetName ¶
func (_options *ListCollectionsOptions) SetName(name string) *ListCollectionsOptions
SetName : Allow user to set Name
type ListCollectionsResponse ¶
type ListCollectionsResponse struct { // An array containing information about each collection in the environment. Collections []Collection `json:"collections,omitempty"` }
ListCollectionsResponse : Response object containing an array of collection details.
type ListConfigurationsOptions ¶
type ListConfigurationsOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // Find configurations with the given name. Name *string `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
ListConfigurationsOptions : The ListConfigurations options.
func (*ListConfigurationsOptions) SetEnvironmentID ¶
func (_options *ListConfigurationsOptions) SetEnvironmentID(environmentID string) *ListConfigurationsOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*ListConfigurationsOptions) SetHeaders ¶
func (options *ListConfigurationsOptions) SetHeaders(param map[string]string) *ListConfigurationsOptions
SetHeaders : Allow user to set Headers
func (*ListConfigurationsOptions) SetName ¶
func (_options *ListConfigurationsOptions) SetName(name string) *ListConfigurationsOptions
SetName : Allow user to set Name
type ListConfigurationsResponse ¶
type ListConfigurationsResponse struct { // An array of configurations that are available for the service instance. Configurations []Configuration `json:"configurations,omitempty"` }
ListConfigurationsResponse : Object containing an array of available configurations.
type ListCredentialsOptions ¶
type ListCredentialsOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
ListCredentialsOptions : The ListCredentials options.
func (*ListCredentialsOptions) SetEnvironmentID ¶
func (_options *ListCredentialsOptions) SetEnvironmentID(environmentID string) *ListCredentialsOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*ListCredentialsOptions) SetHeaders ¶
func (options *ListCredentialsOptions) SetHeaders(param map[string]string) *ListCredentialsOptions
SetHeaders : Allow user to set Headers
type ListEnvironmentsOptions ¶
type ListEnvironmentsOptions struct { // Show only the environment with the given name. Name *string `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
ListEnvironmentsOptions : The ListEnvironments options.
func (*ListEnvironmentsOptions) SetHeaders ¶
func (options *ListEnvironmentsOptions) SetHeaders(param map[string]string) *ListEnvironmentsOptions
SetHeaders : Allow user to set Headers
func (*ListEnvironmentsOptions) SetName ¶
func (_options *ListEnvironmentsOptions) SetName(name string) *ListEnvironmentsOptions
SetName : Allow user to set Name
type ListEnvironmentsResponse ¶
type ListEnvironmentsResponse struct { // An array of [environments] that are available for the service instance. Environments []Environment `json:"environments,omitempty"` }
ListEnvironmentsResponse : Response object containing an array of configured environments.
type ListExpansionsOptions ¶
type ListExpansionsOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
ListExpansionsOptions : The ListExpansions options.
func (*ListExpansionsOptions) SetCollectionID ¶
func (_options *ListExpansionsOptions) SetCollectionID(collectionID string) *ListExpansionsOptions
SetCollectionID : Allow user to set CollectionID
func (*ListExpansionsOptions) SetEnvironmentID ¶
func (_options *ListExpansionsOptions) SetEnvironmentID(environmentID string) *ListExpansionsOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*ListExpansionsOptions) SetHeaders ¶
func (options *ListExpansionsOptions) SetHeaders(param map[string]string) *ListExpansionsOptions
SetHeaders : Allow user to set Headers
type ListFieldsOptions ¶
type ListFieldsOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // A comma-separated list of collection IDs to be queried against. CollectionIds []string `json:"-" validate:"required"` // Allows users to set headers on API requests Headers map[string]string }
ListFieldsOptions : The ListFields options.
func (*ListFieldsOptions) SetCollectionIds ¶
func (_options *ListFieldsOptions) SetCollectionIds(collectionIds []string) *ListFieldsOptions
SetCollectionIds : Allow user to set CollectionIds
func (*ListFieldsOptions) SetEnvironmentID ¶
func (_options *ListFieldsOptions) SetEnvironmentID(environmentID string) *ListFieldsOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*ListFieldsOptions) SetHeaders ¶
func (options *ListFieldsOptions) SetHeaders(param map[string]string) *ListFieldsOptions
SetHeaders : Allow user to set Headers
type ListGatewaysOptions ¶
type ListGatewaysOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
ListGatewaysOptions : The ListGateways options.
func (*ListGatewaysOptions) SetEnvironmentID ¶
func (_options *ListGatewaysOptions) SetEnvironmentID(environmentID string) *ListGatewaysOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*ListGatewaysOptions) SetHeaders ¶
func (options *ListGatewaysOptions) SetHeaders(param map[string]string) *ListGatewaysOptions
SetHeaders : Allow user to set Headers
type ListTrainingDataOptions ¶
type ListTrainingDataOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
ListTrainingDataOptions : The ListTrainingData options.
func (*ListTrainingDataOptions) SetCollectionID ¶
func (_options *ListTrainingDataOptions) SetCollectionID(collectionID string) *ListTrainingDataOptions
SetCollectionID : Allow user to set CollectionID
func (*ListTrainingDataOptions) SetEnvironmentID ¶
func (_options *ListTrainingDataOptions) SetEnvironmentID(environmentID string) *ListTrainingDataOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*ListTrainingDataOptions) SetHeaders ¶
func (options *ListTrainingDataOptions) SetHeaders(param map[string]string) *ListTrainingDataOptions
SetHeaders : Allow user to set Headers
type ListTrainingExamplesOptions ¶
type ListTrainingExamplesOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // The ID of the query used for training. QueryID *string `json:"-" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
ListTrainingExamplesOptions : The ListTrainingExamples options.
func (*ListTrainingExamplesOptions) SetCollectionID ¶
func (_options *ListTrainingExamplesOptions) SetCollectionID(collectionID string) *ListTrainingExamplesOptions
SetCollectionID : Allow user to set CollectionID
func (*ListTrainingExamplesOptions) SetEnvironmentID ¶
func (_options *ListTrainingExamplesOptions) SetEnvironmentID(environmentID string) *ListTrainingExamplesOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*ListTrainingExamplesOptions) SetHeaders ¶
func (options *ListTrainingExamplesOptions) SetHeaders(param map[string]string) *ListTrainingExamplesOptions
SetHeaders : Allow user to set Headers
func (*ListTrainingExamplesOptions) SetQueryID ¶
func (_options *ListTrainingExamplesOptions) SetQueryID(queryID string) *ListTrainingExamplesOptions
SetQueryID : Allow user to set QueryID
type LogQueryResponse ¶
type LogQueryResponse struct { // Number of matching results. MatchingResults *int64 `json:"matching_results,omitempty"` // Array of log query response results. Results []LogQueryResponseResult `json:"results,omitempty"` }
LogQueryResponse : Object containing results that match the requested **logs** query.
type LogQueryResponseResult ¶
type LogQueryResponseResult struct { // The environment ID that is associated with this log entry. EnvironmentID *string `json:"environment_id,omitempty"` // The **customer_id** label that was specified in the header of the query or event API call that corresponds to this // log entry. CustomerID *string `json:"customer_id,omitempty"` // The type of log entry returned. // // **query** indicates that the log represents the results of a call to the single collection **query** method. // // **event** indicates that the log represents a call to the **events** API. DocumentType *string `json:"document_type,omitempty"` // The value of the **natural_language_query** query parameter that was used to create these results. Only returned // with logs of type **query**. // // **Note:** Other query parameters (such as **filter** or **deduplicate**) might have been used with this query, but // are not recorded. NaturalLanguageQuery *string `json:"natural_language_query,omitempty"` // Object containing result information that was returned by the query used to create this log entry. Only returned // with logs of type `query`. DocumentResults *LogQueryResponseResultDocuments `json:"document_results,omitempty"` // Date that the log result was created. Returned in `YYYY-MM-DDThh:mm:ssZ` format. CreatedTimestamp *strfmt.DateTime `json:"created_timestamp,omitempty"` // Date specified by the user when recording an event. Returned in `YYYY-MM-DDThh:mm:ssZ` format. Only returned with // logs of type **event**. ClientTimestamp *strfmt.DateTime `json:"client_timestamp,omitempty"` // Identifier that corresponds to the **natural_language_query** string used in the original or associated query. All // **event** and **query** log entries that have the same original **natural_language_query** string also have them // same **query_id**. This field can be used to recall all **event** and **query** log results that have the same // original query (**event** logs do not contain the original **natural_language_query** field). QueryID *string `json:"query_id,omitempty"` // Unique identifier (within a 24-hour period) that identifies a single `query` log and any `event` logs that were // created for it. // // **Note:** If the exact same query is run at the exact same time on different days, the **session_token** for those // queries might be identical. However, the **created_timestamp** differs. // // **Note:** Session tokens are case sensitive. To avoid matching on session tokens that are identical except for case, // use the exact match operator (`::`) when you query for a specific session token. SessionToken *string `json:"session_token,omitempty"` // The collection ID of the document associated with this event. Only returned with logs of type `event`. CollectionID *string `json:"collection_id,omitempty"` // The original display rank of the document associated with this event. Only returned with logs of type `event`. DisplayRank *int64 `json:"display_rank,omitempty"` // The document ID of the document associated with this event. Only returned with logs of type `event`. DocumentID *string `json:"document_id,omitempty"` // The type of event that this object respresents. Possible values are // // - `query` the log of a query to a collection // // - `click` the result of a call to the **events** endpoint. EventType *string `json:"event_type,omitempty"` // The type of result that this **event** is associated with. Only returned with logs of type `event`. ResultType *string `json:"result_type,omitempty"` }
LogQueryResponseResult : Individual result object for a **logs** query. Each object represents either a query to a Discovery collection or an event that is associated with a query.
type LogQueryResponseResultDocuments ¶
type LogQueryResponseResultDocuments struct { // Array of log query response results. Results []LogQueryResponseResultDocumentsResult `json:"results,omitempty"` // The number of results returned in the query associate with this log. Count *int64 `json:"count,omitempty"` }
LogQueryResponseResultDocuments : Object containing result information that was returned by the query used to create this log entry. Only returned with logs of type `query`.
type LogQueryResponseResultDocumentsResult ¶
type LogQueryResponseResultDocumentsResult struct { // The result rank of this document. A position of `1` indicates that it was the first returned result. Position *int64 `json:"position,omitempty"` // The **document_id** of the document that this result represents. DocumentID *string `json:"document_id,omitempty"` // The raw score of this result. A higher score indicates a greater match to the query parameters. Score *float64 `json:"score,omitempty"` // The confidence score of the result's analysis. A higher score indicating greater confidence. Confidence *float64 `json:"confidence,omitempty"` // The **collection_id** of the document represented by this result. CollectionID *string `json:"collection_id,omitempty"` }
LogQueryResponseResultDocumentsResult : Each object in the **results** array corresponds to an individual document returned by the original query.
type MetricAggregation ¶
type MetricAggregation struct { // The measurement interval for this metric. Metric intervals are always 1 day (`1d`). Interval *string `json:"interval,omitempty"` // The event type associated with this metric result. This field, when present, will always be `click`. EventType *string `json:"event_type,omitempty"` // Array of metric aggregation query results. Results []MetricAggregationResult `json:"results,omitempty"` }
MetricAggregation : An aggregation analyzing log information for queries and events.
type MetricAggregationResult ¶
type MetricAggregationResult struct { // Date in string form representing the start of this interval. KeyAsString *strfmt.DateTime `json:"key_as_string,omitempty"` // Unix epoch time equivalent of the **key_as_string**, that represents the start of this interval. Key *int64 `json:"key,omitempty"` // Number of matching results. MatchingResults *int64 `json:"matching_results,omitempty"` // The number of queries with associated events divided by the total number of queries for the interval. Only returned // with **event_rate** metrics. EventRate *float64 `json:"event_rate,omitempty"` }
MetricAggregationResult : Aggregation result data for the requested metric.
type MetricResponse ¶
type MetricResponse struct { // Array of metric aggregations. Aggregations []MetricAggregation `json:"aggregations,omitempty"` }
MetricResponse : The response generated from a call to a **metrics** method.
type MetricTokenAggregation ¶
type MetricTokenAggregation struct { // The event type associated with this metric result. This field, when present, will always be `click`. EventType *string `json:"event_type,omitempty"` // Array of results for the metric token aggregation. Results []MetricTokenAggregationResult `json:"results,omitempty"` }
MetricTokenAggregation : An aggregation analyzing log information for queries and events.
type MetricTokenAggregationResult ¶
type MetricTokenAggregationResult struct { // The content of the **natural_language_query** parameter used in the query that this result represents. Key *string `json:"key,omitempty"` // Number of matching results. MatchingResults *int64 `json:"matching_results,omitempty"` // The number of queries with associated events divided by the total number of queries currently stored (queries and // events are stored in the log for 30 days). EventRate *float64 `json:"event_rate,omitempty"` }
MetricTokenAggregationResult : Aggregation result data for the requested metric.
type MetricTokenResponse ¶
type MetricTokenResponse struct { // Array of metric token aggregations. Aggregations []MetricTokenAggregation `json:"aggregations,omitempty"` }
MetricTokenResponse : The response generated from a call to a **metrics** method that evaluates tokens.
type Nested ¶
type Nested struct { // The type of aggregation command used. For example: term, filter, max, min, etc. Type *string `json:"type,omitempty"` // Array of aggregation results. Results []AggregationResult `json:"results,omitempty"` // Number of matching results. MatchingResults *int64 `json:"matching_results,omitempty"` // Aggregations returned by Discovery. Aggregations []QueryAggregationIntf `json:"aggregations,omitempty"` // The area of the results the aggregation was restricted to. Path *string `json:"path,omitempty"` }
Nested : Nested struct This model "extends" QueryAggregation
type NluEnrichmentConcepts ¶
type NluEnrichmentConcepts struct { // The maximum number of concepts enrichments to extact from each instance of the specified field. Limit *int64 `json:"limit,omitempty"` }
NluEnrichmentConcepts : An object specifiying the concepts enrichment and related parameters.
type NluEnrichmentEmotion ¶
type NluEnrichmentEmotion struct { // When `true`, emotion detection is performed on the entire field. Document *bool `json:"document,omitempty"` // A comma-separated list of target strings that will have any associated emotions detected. Targets []string `json:"targets,omitempty"` }
NluEnrichmentEmotion : An object specifying the emotion detection enrichment and related parameters.
type NluEnrichmentEntities ¶
type NluEnrichmentEntities struct { // When `true`, sentiment analysis of entities will be performed on the specified field. Sentiment *bool `json:"sentiment,omitempty"` // When `true`, emotion detection of entities will be performed on the specified field. Emotion *bool `json:"emotion,omitempty"` // The maximum number of entities to extract for each instance of the specified field. Limit *int64 `json:"limit,omitempty"` // When `true`, the number of mentions of each identified entity is recorded. The default is `false`. Mentions *bool `json:"mentions,omitempty"` // When `true`, the types of mentions for each idetifieid entity is recorded. The default is `false`. MentionTypes *bool `json:"mention_types,omitempty"` // When `true`, a list of sentence locations for each instance of each identified entity is recorded. The default is // `false`. SentenceLocations *bool `json:"sentence_locations,omitempty"` // The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, or // the default public model `alchemy`. Model *string `json:"model,omitempty"` }
NluEnrichmentEntities : An object speficying the Entities enrichment and related parameters.
type NluEnrichmentFeatures ¶
type NluEnrichmentFeatures struct { // An object specifying the Keyword enrichment and related parameters. Keywords *NluEnrichmentKeywords `json:"keywords,omitempty"` // An object speficying the Entities enrichment and related parameters. Entities *NluEnrichmentEntities `json:"entities,omitempty"` // An object specifying the sentiment extraction enrichment and related parameters. Sentiment *NluEnrichmentSentiment `json:"sentiment,omitempty"` // An object specifying the emotion detection enrichment and related parameters. Emotion *NluEnrichmentEmotion `json:"emotion,omitempty"` // An object that indicates the Categories enrichment will be applied to the specified field. Categories map[string]interface{} `json:"categories,omitempty"` // An object specifiying the semantic roles enrichment and related parameters. SemanticRoles *NluEnrichmentSemanticRoles `json:"semantic_roles,omitempty"` // An object specifying the relations enrichment and related parameters. Relations *NluEnrichmentRelations `json:"relations,omitempty"` // An object specifiying the concepts enrichment and related parameters. Concepts *NluEnrichmentConcepts `json:"concepts,omitempty"` }
NluEnrichmentFeatures : Object containing Natural Language Understanding features to be used.
type NluEnrichmentKeywords ¶
type NluEnrichmentKeywords struct { // When `true`, sentiment analysis of keywords will be performed on the specified field. Sentiment *bool `json:"sentiment,omitempty"` // When `true`, emotion detection of keywords will be performed on the specified field. Emotion *bool `json:"emotion,omitempty"` // The maximum number of keywords to extract for each instance of the specified field. Limit *int64 `json:"limit,omitempty"` }
NluEnrichmentKeywords : An object specifying the Keyword enrichment and related parameters.
type NluEnrichmentRelations ¶
type NluEnrichmentRelations struct { // *For use with `natural_language_understanding` enrichments only.* The enrichement model to use with relationship // extraction. May be a custom model provided by Watson Knowledge Studio, the default public model is`en-news`. Model *string `json:"model,omitempty"` }
NluEnrichmentRelations : An object specifying the relations enrichment and related parameters.
type NluEnrichmentSemanticRoles ¶
type NluEnrichmentSemanticRoles struct { // When `true`, entities are extracted from the identified sentence parts. Entities *bool `json:"entities,omitempty"` // When `true`, keywords are extracted from the identified sentence parts. Keywords *bool `json:"keywords,omitempty"` // The maximum number of semantic roles enrichments to extact from each instance of the specified field. Limit *int64 `json:"limit,omitempty"` }
NluEnrichmentSemanticRoles : An object specifiying the semantic roles enrichment and related parameters.
type NluEnrichmentSentiment ¶
type NluEnrichmentSentiment struct { // When `true`, sentiment analysis is performed on the entire field. Document *bool `json:"document,omitempty"` // A comma-separated list of target strings that will have any associated sentiment analyzed. Targets []string `json:"targets,omitempty"` }
NluEnrichmentSentiment : An object specifying the sentiment extraction enrichment and related parameters.
type NormalizationOperation ¶
type NormalizationOperation struct { // Identifies what type of operation to perform. // // **copy** - Copies the value of the **source_field** to the **destination_field** field. If the **destination_field** // already exists, then the value of the **source_field** overwrites the original value of the **destination_field**. // // **move** - Renames (moves) the **source_field** to the **destination_field**. If the **destination_field** already // exists, then the value of the **source_field** overwrites the original value of the **destination_field**. Rename is // identical to copy, except that the **source_field** is removed after the value has been copied to the // **destination_field** (it is the same as a _copy_ followed by a _remove_). // // **merge** - Merges the value of the **source_field** with the value of the **destination_field**. The // **destination_field** is converted into an array if it is not already an array, and the value of the // **source_field** is appended to the array. This operation removes the **source_field** after the merge. If the // **source_field** does not exist in the current document, then the **destination_field** is still converted into an // array (if it is not an array already). This conversion ensures the type for **destination_field** is consistent // across all documents. // // **remove** - Deletes the **source_field** field. The **destination_field** is ignored for this operation. // // **remove_nulls** - Removes all nested null (blank) field values from the ingested document. **source_field** and // **destination_field** are ignored by this operation because _remove_nulls_ operates on the entire ingested document. // Typically, **remove_nulls** is invoked as the last normalization operation (if it is invoked at all, it can be // time-expensive). Operation *string `json:"operation,omitempty"` // The source field for the operation. SourceField *string `json:"source_field,omitempty"` // The destination field for the operation. DestinationField *string `json:"destination_field,omitempty"` }
NormalizationOperation : Object containing normalization operations.
type Notice ¶
type Notice struct { // Identifies the notice. Many notices might have the same ID. This field exists so that user applications can // programmatically identify a notice and take automatic corrective action. Typical notice IDs include: `index_failed`, // `index_failed_too_many_requests`, `index_failed_incompatible_field`, `index_failed_cluster_unavailable`, // `ingestion_timeout`, `ingestion_error`, `bad_request`, `internal_error`, `missing_model`, `unsupported_model`, // `smart_document_understanding_failed_incompatible_field`, `smart_document_understanding_failed_internal_error`, // `smart_document_understanding_failed_internal_error`, `smart_document_understanding_failed_warning`, // `smart_document_understanding_page_error`, `smart_document_understanding_page_warning`. **Note:** This is not a // complete list; other values might be returned. NoticeID *string `json:"notice_id,omitempty"` // The creation date of the collection in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. Created *strfmt.DateTime `json:"created,omitempty"` // Unique identifier of the document. DocumentID *string `json:"document_id,omitempty"` // Unique identifier of the query used for relevance training. QueryID *string `json:"query_id,omitempty"` // Severity level of the notice. Severity *string `json:"severity,omitempty"` // Ingestion or training step in which the notice occurred. Typical step values include: `smartDocumentUnderstanding`, // `ingestion`, `indexing`, `convert`. **Note:** This is not a complete list; other values might be returned. Step *string `json:"step,omitempty"` // The description of the notice. Description *string `json:"description,omitempty"` }
Notice : A notice produced for the collection.
type PDFHeadingDetection ¶
type PDFHeadingDetection struct { // Array of font matching configurations. Fonts []FontSetting `json:"fonts,omitempty"` }
PDFHeadingDetection : Object containing heading detection conversion settings for PDF documents.
type PDFSettings ¶
type PDFSettings struct { // Object containing heading detection conversion settings for PDF documents. Heading *PDFHeadingDetection `json:"heading,omitempty"` }
PDFSettings : A list of PDF conversion settings.
type QueryAggregation ¶
type QueryAggregation struct { // The type of aggregation command used. For example: term, filter, max, min, etc. Type *string `json:"type,omitempty"` // Array of aggregation results. Results []AggregationResult `json:"results,omitempty"` // Number of matching results. MatchingResults *int64 `json:"matching_results,omitempty"` // Aggregations returned by Discovery. Aggregations []QueryAggregationIntf `json:"aggregations,omitempty"` }
QueryAggregation : An aggregation produced by Discovery to analyze the input provided.
type QueryAggregationIntf ¶
type QueryAggregationIntf interface {
// contains filtered or unexported methods
}
type QueryLogOptions ¶
type QueryLogOptions struct { // A cacheable query that excludes documents that don't mention the query content. Filter searches are better for // metadata-type searches and for assessing the concepts in the data set. Filter *string `json:"-"` // A query search returns all documents in your data set with full enrichments and full text, but with the most // relevant documents listed first. Query *string `json:"-"` // Number of results to return. The maximum for the **count** and **offset** values together in any one query is // **10000**. Count *int64 `json:"-"` // The number of query results to skip at the beginning. For example, if the total number of results that are returned // is 10 and the offset is 8, it returns the last two results. The maximum for the **count** and **offset** values // together in any one query is **10000**. Offset *int64 `json:"-"` // A comma-separated list of fields in the document to sort on. You can optionally specify a sort direction by // prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no // prefix is specified. Sort []string `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
QueryLogOptions : The QueryLog options.
func (*QueryLogOptions) SetCount ¶
func (_options *QueryLogOptions) SetCount(count int64) *QueryLogOptions
SetCount : Allow user to set Count
func (*QueryLogOptions) SetFilter ¶
func (_options *QueryLogOptions) SetFilter(filter string) *QueryLogOptions
SetFilter : Allow user to set Filter
func (*QueryLogOptions) SetHeaders ¶
func (options *QueryLogOptions) SetHeaders(param map[string]string) *QueryLogOptions
SetHeaders : Allow user to set Headers
func (*QueryLogOptions) SetOffset ¶
func (_options *QueryLogOptions) SetOffset(offset int64) *QueryLogOptions
SetOffset : Allow user to set Offset
func (*QueryLogOptions) SetQuery ¶
func (_options *QueryLogOptions) SetQuery(query string) *QueryLogOptions
SetQuery : Allow user to set Query
func (*QueryLogOptions) SetSort ¶
func (_options *QueryLogOptions) SetSort(sort []string) *QueryLogOptions
SetSort : Allow user to set Sort
type QueryNoticesOptions ¶
type QueryNoticesOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // A cacheable query that excludes documents that don't mention the query content. Filter searches are better for // metadata-type searches and for assessing the concepts in the data set. Filter *string `json:"-"` // A query search returns all documents in your data set with full enrichments and full text, but with the most // relevant documents listed first. Query *string `json:"-"` // A natural language query that returns relevant documents by utilizing training data and natural language // understanding. NaturalLanguageQuery *string `json:"-"` // A passages query that returns the most relevant passages from the results. Passages *bool `json:"-"` // An aggregation search that returns an exact answer by combining query search with filters. Useful for applications // to build lists, tables, and time series. For a full list of possible aggregations, see the Query reference. Aggregation *string `json:"-"` // Number of results to return. The maximum for the **count** and **offset** values together in any one query is // **10000**. Count *int64 `json:"-"` // A comma-separated list of the portion of the document hierarchy to return. Return []string `json:"-"` // The number of query results to skip at the beginning. For example, if the total number of results that are returned // is 10 and the offset is 8, it returns the last two results. The maximum for the **count** and **offset** values // together in any one query is **10000**. Offset *int64 `json:"-"` // A comma-separated list of fields in the document to sort on. You can optionally specify a sort direction by // prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no // prefix is specified. Sort []string `json:"-"` // When true, a highlight field is returned for each result which contains the fields which match the query with // `<em></em>` tags around the matching query terms. Highlight *bool `json:"-"` // A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all top-level // fields are included. PassagesFields []string `json:"-"` // The maximum number of passages to return. The search returns fewer passages if the requested total is not found. PassagesCount *int64 `json:"-"` // The approximate number of characters that any one passage will have. PassagesCharacters *int64 `json:"-"` // When specified, duplicate results based on the field specified are removed from the returned results. Duplicate // comparison is limited to the current query only, **offset** is not considered. This parameter is currently Beta // functionality. DeduplicateField *string `json:"-"` // When `true`, results are returned based on their similarity to the document IDs specified in the // **similar.document_ids** parameter. Similar *bool `json:"-"` // A comma-separated list of document IDs to find similar documents. // // **Tip:** Include the **natural_language_query** parameter to expand the scope of the document similarity search with // the natural language query. Other query parameters, such as **filter** and **query**, are subsequently applied and // reduce the scope. SimilarDocumentIds []string `json:"-"` // A comma-separated list of field names that are used as a basis for comparison to identify similar documents. If not // specified, the entire document is used for comparison. SimilarFields []string `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
QueryNoticesOptions : The QueryNotices options.
func (*QueryNoticesOptions) SetAggregation ¶
func (_options *QueryNoticesOptions) SetAggregation(aggregation string) *QueryNoticesOptions
SetAggregation : Allow user to set Aggregation
func (*QueryNoticesOptions) SetCollectionID ¶
func (_options *QueryNoticesOptions) SetCollectionID(collectionID string) *QueryNoticesOptions
SetCollectionID : Allow user to set CollectionID
func (*QueryNoticesOptions) SetCount ¶
func (_options *QueryNoticesOptions) SetCount(count int64) *QueryNoticesOptions
SetCount : Allow user to set Count
func (*QueryNoticesOptions) SetDeduplicateField ¶
func (_options *QueryNoticesOptions) SetDeduplicateField(deduplicateField string) *QueryNoticesOptions
SetDeduplicateField : Allow user to set DeduplicateField
func (*QueryNoticesOptions) SetEnvironmentID ¶
func (_options *QueryNoticesOptions) SetEnvironmentID(environmentID string) *QueryNoticesOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*QueryNoticesOptions) SetFilter ¶
func (_options *QueryNoticesOptions) SetFilter(filter string) *QueryNoticesOptions
SetFilter : Allow user to set Filter
func (*QueryNoticesOptions) SetHeaders ¶
func (options *QueryNoticesOptions) SetHeaders(param map[string]string) *QueryNoticesOptions
SetHeaders : Allow user to set Headers
func (*QueryNoticesOptions) SetHighlight ¶
func (_options *QueryNoticesOptions) SetHighlight(highlight bool) *QueryNoticesOptions
SetHighlight : Allow user to set Highlight
func (*QueryNoticesOptions) SetNaturalLanguageQuery ¶
func (_options *QueryNoticesOptions) SetNaturalLanguageQuery(naturalLanguageQuery string) *QueryNoticesOptions
SetNaturalLanguageQuery : Allow user to set NaturalLanguageQuery
func (*QueryNoticesOptions) SetOffset ¶
func (_options *QueryNoticesOptions) SetOffset(offset int64) *QueryNoticesOptions
SetOffset : Allow user to set Offset
func (*QueryNoticesOptions) SetPassages ¶
func (_options *QueryNoticesOptions) SetPassages(passages bool) *QueryNoticesOptions
SetPassages : Allow user to set Passages
func (*QueryNoticesOptions) SetPassagesCharacters ¶
func (_options *QueryNoticesOptions) SetPassagesCharacters(passagesCharacters int64) *QueryNoticesOptions
SetPassagesCharacters : Allow user to set PassagesCharacters
func (*QueryNoticesOptions) SetPassagesCount ¶
func (_options *QueryNoticesOptions) SetPassagesCount(passagesCount int64) *QueryNoticesOptions
SetPassagesCount : Allow user to set PassagesCount
func (*QueryNoticesOptions) SetPassagesFields ¶
func (_options *QueryNoticesOptions) SetPassagesFields(passagesFields []string) *QueryNoticesOptions
SetPassagesFields : Allow user to set PassagesFields
func (*QueryNoticesOptions) SetQuery ¶
func (_options *QueryNoticesOptions) SetQuery(query string) *QueryNoticesOptions
SetQuery : Allow user to set Query
func (*QueryNoticesOptions) SetReturn ¶
func (_options *QueryNoticesOptions) SetReturn(returnVar []string) *QueryNoticesOptions
SetReturn : Allow user to set Return
func (*QueryNoticesOptions) SetSimilar ¶
func (_options *QueryNoticesOptions) SetSimilar(similar bool) *QueryNoticesOptions
SetSimilar : Allow user to set Similar
func (*QueryNoticesOptions) SetSimilarDocumentIds ¶
func (_options *QueryNoticesOptions) SetSimilarDocumentIds(similarDocumentIds []string) *QueryNoticesOptions
SetSimilarDocumentIds : Allow user to set SimilarDocumentIds
func (*QueryNoticesOptions) SetSimilarFields ¶
func (_options *QueryNoticesOptions) SetSimilarFields(similarFields []string) *QueryNoticesOptions
SetSimilarFields : Allow user to set SimilarFields
func (*QueryNoticesOptions) SetSort ¶
func (_options *QueryNoticesOptions) SetSort(sort []string) *QueryNoticesOptions
SetSort : Allow user to set Sort
type QueryNoticesResponse ¶
type QueryNoticesResponse struct { // The number of matching results. MatchingResults *int64 `json:"matching_results,omitempty"` // Array of document results that match the query. Results []QueryNoticesResult `json:"results,omitempty"` // Array of aggregation results that match the query. Aggregations []QueryAggregationIntf `json:"aggregations,omitempty"` // Array of passage results that match the query. Passages []QueryPassages `json:"passages,omitempty"` // The number of duplicates removed from this notices query. DuplicatesRemoved *int64 `json:"duplicates_removed,omitempty"` }
QueryNoticesResponse : Object containing notice query results.
type QueryNoticesResult ¶
type QueryNoticesResult struct { // The unique identifier of the document. ID *string `json:"id,omitempty"` // Metadata of the document. Metadata map[string]interface{} `json:"metadata,omitempty"` // The collection ID of the collection containing the document for this result. CollectionID *string `json:"collection_id,omitempty"` // Metadata of a query result. ResultMetadata *QueryResultMetadata `json:"result_metadata,omitempty"` // The internal status code returned by the ingestion subsystem indicating the overall result of ingesting the source // document. Code *int64 `json:"code,omitempty"` // Name of the original source file (if available). Filename *string `json:"filename,omitempty"` // The type of the original source file. FileType *string `json:"file_type,omitempty"` // The SHA-1 hash of the original source file (formatted as a hexadecimal string). Sha1 *string `json:"sha1,omitempty"` // Array of notices for the document. Notices []Notice `json:"notices,omitempty"` // contains filtered or unexported fields }
QueryNoticesResult : Query result object.
func (*QueryNoticesResult) GetProperties ¶
func (o *QueryNoticesResult) GetProperties() map[string]interface{}
GetProperties allows the user to retrieve the map of arbitrary properties from an instance of QueryNoticesResult
func (*QueryNoticesResult) GetProperty ¶
func (o *QueryNoticesResult) GetProperty(key string) interface{}
GetProperty allows the user to retrieve an arbitrary property from an instance of QueryNoticesResult
func (*QueryNoticesResult) MarshalJSON ¶
func (o *QueryNoticesResult) MarshalJSON() (buffer []byte, err error)
MarshalJSON performs custom serialization for instances of QueryNoticesResult
func (*QueryNoticesResult) SetProperties ¶ added in v2.2.0
func (o *QueryNoticesResult) SetProperties(m map[string]interface{})
SetProperties allows the user to set a map of arbitrary properties on an instance of QueryNoticesResult
func (*QueryNoticesResult) SetProperty ¶
func (o *QueryNoticesResult) SetProperty(key string, value interface{})
SetProperty allows the user to set an arbitrary property on an instance of QueryNoticesResult
type QueryOptions ¶
type QueryOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // A cacheable query that excludes documents that don't mention the query content. Filter searches are better for // metadata-type searches and for assessing the concepts in the data set. Filter *string `json:"filter,omitempty"` // A query search returns all documents in your data set with full enrichments and full text, but with the most // relevant documents listed first. Use a query search when you want to find the most relevant search results. Query *string `json:"query,omitempty"` // A natural language query that returns relevant documents by utilizing training data and natural language // understanding. NaturalLanguageQuery *string `json:"natural_language_query,omitempty"` // A passages query that returns the most relevant passages from the results. Passages *bool `json:"passages,omitempty"` // An aggregation search that returns an exact answer by combining query search with filters. Useful for applications // to build lists, tables, and time series. For a full list of possible aggregations, see the Query reference. Aggregation *string `json:"aggregation,omitempty"` // Number of results to return. Count *int64 `json:"count,omitempty"` // A comma-separated list of the portion of the document hierarchy to return. Return *string `json:"return,omitempty"` // The number of query results to skip at the beginning. For example, if the total number of results that are returned // is 10 and the offset is 8, it returns the last two results. Offset *int64 `json:"offset,omitempty"` // A comma-separated list of fields in the document to sort on. You can optionally specify a sort direction by // prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no // prefix is specified. This parameter cannot be used in the same query as the **bias** parameter. Sort *string `json:"sort,omitempty"` // When true, a highlight field is returned for each result which contains the fields which match the query with // `<em></em>` tags around the matching query terms. Highlight *bool `json:"highlight,omitempty"` // A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all top-level // fields are included. PassagesFields *string `json:"passages.fields,omitempty"` // The maximum number of passages to return. The search returns fewer passages if the requested total is not found. The // default is `10`. The maximum is `100`. PassagesCount *int64 `json:"passages.count,omitempty"` // The approximate number of characters that any one passage will have. PassagesCharacters *int64 `json:"passages.characters,omitempty"` // When `true`, and used with a Watson Discovery News collection, duplicate results (based on the contents of the // **title** field) are removed. Duplicate comparison is limited to the current query only; **offset** is not // considered. This parameter is currently Beta functionality. Deduplicate *bool `json:"deduplicate,omitempty"` // When specified, duplicate results based on the field specified are removed from the returned results. Duplicate // comparison is limited to the current query only, **offset** is not considered. This parameter is currently Beta // functionality. DeduplicateField *string `json:"deduplicate.field,omitempty"` // When `true`, results are returned based on their similarity to the document IDs specified in the // **similar.document_ids** parameter. Similar *bool `json:"similar,omitempty"` // A comma-separated list of document IDs to find similar documents. // // **Tip:** Include the **natural_language_query** parameter to expand the scope of the document similarity search with // the natural language query. Other query parameters, such as **filter** and **query**, are subsequently applied and // reduce the scope. SimilarDocumentIds *string `json:"similar.document_ids,omitempty"` // A comma-separated list of field names that are used as a basis for comparison to identify similar documents. If not // specified, the entire document is used for comparison. SimilarFields *string `json:"similar.fields,omitempty"` // Field which the returned results will be biased against. The specified field must be either a **date** or **number** // format. When a **date** type field is specified returned results are biased towards field values closer to the // current date. When a **number** type field is specified, returned results are biased towards higher field values. // This parameter cannot be used in the same query as the **sort** parameter. Bias *string `json:"bias,omitempty"` // When `true` and the **natural_language_query** parameter is used, the **natural_languge_query** parameter is spell // checked. The most likely correction is returned in the **suggested_query** field of the response (if one exists). // // **Important:** this parameter is only valid when using the Cloud Pak version of Discovery. SpellingSuggestions *bool `json:"spelling_suggestions,omitempty"` // If `true`, queries are not stored in the Discovery **Logs** endpoint. XWatsonLoggingOptOut *bool `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
QueryOptions : The Query options.
func (*QueryOptions) SetAggregation ¶
func (_options *QueryOptions) SetAggregation(aggregation string) *QueryOptions
SetAggregation : Allow user to set Aggregation
func (*QueryOptions) SetBias ¶
func (_options *QueryOptions) SetBias(bias string) *QueryOptions
SetBias : Allow user to set Bias
func (*QueryOptions) SetCollectionID ¶
func (_options *QueryOptions) SetCollectionID(collectionID string) *QueryOptions
SetCollectionID : Allow user to set CollectionID
func (*QueryOptions) SetCount ¶
func (_options *QueryOptions) SetCount(count int64) *QueryOptions
SetCount : Allow user to set Count
func (*QueryOptions) SetDeduplicate ¶
func (_options *QueryOptions) SetDeduplicate(deduplicate bool) *QueryOptions
SetDeduplicate : Allow user to set Deduplicate
func (*QueryOptions) SetDeduplicateField ¶
func (_options *QueryOptions) SetDeduplicateField(deduplicateField string) *QueryOptions
SetDeduplicateField : Allow user to set DeduplicateField
func (*QueryOptions) SetEnvironmentID ¶
func (_options *QueryOptions) SetEnvironmentID(environmentID string) *QueryOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*QueryOptions) SetFilter ¶
func (_options *QueryOptions) SetFilter(filter string) *QueryOptions
SetFilter : Allow user to set Filter
func (*QueryOptions) SetHeaders ¶
func (options *QueryOptions) SetHeaders(param map[string]string) *QueryOptions
SetHeaders : Allow user to set Headers
func (*QueryOptions) SetHighlight ¶
func (_options *QueryOptions) SetHighlight(highlight bool) *QueryOptions
SetHighlight : Allow user to set Highlight
func (*QueryOptions) SetNaturalLanguageQuery ¶
func (_options *QueryOptions) SetNaturalLanguageQuery(naturalLanguageQuery string) *QueryOptions
SetNaturalLanguageQuery : Allow user to set NaturalLanguageQuery
func (*QueryOptions) SetOffset ¶
func (_options *QueryOptions) SetOffset(offset int64) *QueryOptions
SetOffset : Allow user to set Offset
func (*QueryOptions) SetPassages ¶
func (_options *QueryOptions) SetPassages(passages bool) *QueryOptions
SetPassages : Allow user to set Passages
func (*QueryOptions) SetPassagesCharacters ¶
func (_options *QueryOptions) SetPassagesCharacters(passagesCharacters int64) *QueryOptions
SetPassagesCharacters : Allow user to set PassagesCharacters
func (*QueryOptions) SetPassagesCount ¶
func (_options *QueryOptions) SetPassagesCount(passagesCount int64) *QueryOptions
SetPassagesCount : Allow user to set PassagesCount
func (*QueryOptions) SetPassagesFields ¶
func (_options *QueryOptions) SetPassagesFields(passagesFields string) *QueryOptions
SetPassagesFields : Allow user to set PassagesFields
func (*QueryOptions) SetQuery ¶
func (_options *QueryOptions) SetQuery(query string) *QueryOptions
SetQuery : Allow user to set Query
func (*QueryOptions) SetReturn ¶
func (_options *QueryOptions) SetReturn(returnVar string) *QueryOptions
SetReturn : Allow user to set Return
func (*QueryOptions) SetSimilar ¶
func (_options *QueryOptions) SetSimilar(similar bool) *QueryOptions
SetSimilar : Allow user to set Similar
func (*QueryOptions) SetSimilarDocumentIds ¶
func (_options *QueryOptions) SetSimilarDocumentIds(similarDocumentIds string) *QueryOptions
SetSimilarDocumentIds : Allow user to set SimilarDocumentIds
func (*QueryOptions) SetSimilarFields ¶
func (_options *QueryOptions) SetSimilarFields(similarFields string) *QueryOptions
SetSimilarFields : Allow user to set SimilarFields
func (*QueryOptions) SetSort ¶
func (_options *QueryOptions) SetSort(sort string) *QueryOptions
SetSort : Allow user to set Sort
func (*QueryOptions) SetSpellingSuggestions ¶
func (_options *QueryOptions) SetSpellingSuggestions(spellingSuggestions bool) *QueryOptions
SetSpellingSuggestions : Allow user to set SpellingSuggestions
func (*QueryOptions) SetXWatsonLoggingOptOut ¶
func (_options *QueryOptions) SetXWatsonLoggingOptOut(xWatsonLoggingOptOut bool) *QueryOptions
SetXWatsonLoggingOptOut : Allow user to set XWatsonLoggingOptOut
type QueryPassages ¶
type QueryPassages struct { // The unique identifier of the document from which the passage has been extracted. DocumentID *string `json:"document_id,omitempty"` // The confidence score of the passages's analysis. A higher score indicates greater confidence. PassageScore *float64 `json:"passage_score,omitempty"` // The content of the extracted passage. PassageText *string `json:"passage_text,omitempty"` // The position of the first character of the extracted passage in the originating field. StartOffset *int64 `json:"start_offset,omitempty"` // The position of the last character of the extracted passage in the originating field. EndOffset *int64 `json:"end_offset,omitempty"` // The label of the field from which the passage has been extracted. Field *string `json:"field,omitempty"` }
QueryPassages : A passage query result.
type QueryResponse ¶
type QueryResponse struct { // The number of matching results for the query. MatchingResults *int64 `json:"matching_results,omitempty"` // Array of document results for the query. Results []QueryResult `json:"results,omitempty"` // Array of aggregation results for the query. Aggregations []QueryAggregationIntf `json:"aggregations,omitempty"` // Array of passage results for the query. Passages []QueryPassages `json:"passages,omitempty"` // The number of duplicate results removed. DuplicatesRemoved *int64 `json:"duplicates_removed,omitempty"` // The session token for this query. The session token can be used to add events associated with this query to the // query and event log. // // **Important:** Session tokens are case sensitive. SessionToken *string `json:"session_token,omitempty"` // An object contain retrieval type information. RetrievalDetails *RetrievalDetails `json:"retrieval_details,omitempty"` // The suggestions for a misspelled natural language query. SuggestedQuery *string `json:"suggested_query,omitempty"` }
QueryResponse : A response containing the documents and aggregations for the query.
type QueryResult ¶
type QueryResult struct { // The unique identifier of the document. ID *string `json:"id,omitempty"` // Metadata of the document. Metadata map[string]interface{} `json:"metadata,omitempty"` // The collection ID of the collection containing the document for this result. CollectionID *string `json:"collection_id,omitempty"` // Metadata of a query result. ResultMetadata *QueryResultMetadata `json:"result_metadata,omitempty"` // contains filtered or unexported fields }
QueryResult : Query result object.
func (*QueryResult) GetProperties ¶
func (o *QueryResult) GetProperties() map[string]interface{}
GetProperties allows the user to retrieve the map of arbitrary properties from an instance of QueryResult
func (*QueryResult) GetProperty ¶
func (o *QueryResult) GetProperty(key string) interface{}
GetProperty allows the user to retrieve an arbitrary property from an instance of QueryResult
func (*QueryResult) MarshalJSON ¶
func (o *QueryResult) MarshalJSON() (buffer []byte, err error)
MarshalJSON performs custom serialization for instances of QueryResult
func (*QueryResult) SetProperties ¶ added in v2.2.0
func (o *QueryResult) SetProperties(m map[string]interface{})
SetProperties allows the user to set a map of arbitrary properties on an instance of QueryResult
func (*QueryResult) SetProperty ¶
func (o *QueryResult) SetProperty(key string, value interface{})
SetProperty allows the user to set an arbitrary property on an instance of QueryResult
type QueryResultMetadata ¶
type QueryResultMetadata struct { // An unbounded measure of the relevance of a particular result, dependent on the query and matching document. A higher // score indicates a greater match to the query parameters. Score *float64 `json:"score" validate:"required"` // The confidence score for the given result. Calculated based on how relevant the result is estimated to be. // confidence can range from `0.0` to `1.0`. The higher the number, the more relevant the document. The `confidence` // value for a result was calculated using the model specified in the `document_retrieval_strategy` field of the result // set. Confidence *float64 `json:"confidence,omitempty"` }
QueryResultMetadata : Metadata of a query result.
type RetrievalDetails ¶
type RetrievalDetails struct { // Indentifies the document retrieval strategy used for this query. `relevancy_training` indicates that the results // were returned using a relevancy trained model. `continuous_relevancy_training` indicates that the results were // returned using the continuous relevancy training model created by result feedback analysis. `untrained` means the // results were returned using the standard untrained model. // // **Note**: In the event of trained collections being queried, but the trained model is not used to return results, // the **document_retrieval_strategy** will be listed as `untrained`. DocumentRetrievalStrategy *string `json:"document_retrieval_strategy,omitempty"` }
RetrievalDetails : An object contain retrieval type information.
type SduStatus ¶
type SduStatus struct { // When `true`, smart document understanding conversion is enabled for this collection. All collections created with a // version date after `2019-04-30` have smart document understanding enabled. If `false`, documents added to the // collection are converted using the **conversion** settings specified in the configuration associated with the // collection. Enabled *bool `json:"enabled,omitempty"` // The total number of pages annotated using smart document understanding in this collection. TotalAnnotatedPages *int64 `json:"total_annotated_pages,omitempty"` // The current number of pages that can be used for training smart document understanding. The `total_pages` number is // calculated as the total number of pages identified from the documents listed in the **total_documents** field. TotalPages *int64 `json:"total_pages,omitempty"` // The total number of documents in this collection that can be used to train smart document understanding. For // **lite** plan collections, the maximum is the first 20 uploaded documents (not including HTML or JSON documents). // For other plans, the maximum is the first 40 uploaded documents (not including HTML or JSON documents). When the // maximum is reached, additional documents uploaded to the collection are not considered for training smart document // understanding. TotalDocuments *int64 `json:"total_documents,omitempty"` // Information about custom smart document understanding fields that exist in this collection. CustomFields *SduStatusCustomFields `json:"custom_fields,omitempty"` }
SduStatus : Object containing smart document understanding information for this collection.
type SduStatusCustomFields ¶
type SduStatusCustomFields struct { // The number of custom fields defined for this collection. Defined *int64 `json:"defined,omitempty"` // The maximum number of custom fields that are allowed in this collection. MaximumAllowed *int64 `json:"maximum_allowed,omitempty"` }
SduStatusCustomFields : Information about custom smart document understanding fields that exist in this collection.
type SearchStatus ¶
type SearchStatus struct { // Current scope of the training. Always returned as `environment`. Scope *string `json:"scope,omitempty"` // The current status of Continuous Relevancy Training for this environment. Status *string `json:"status,omitempty"` // Long description of the current Continuous Relevancy Training status. StatusDescription *string `json:"status_description,omitempty"` // The date stamp of the most recent completed training for this environment. LastTrained *strfmt.Date `json:"last_trained,omitempty"` }
SearchStatus : Information about the Continuous Relevancy Training for this environment.
type SegmentSettings ¶
type SegmentSettings struct { // Enables/disables the Document Segmentation feature. Enabled *bool `json:"enabled,omitempty"` // Defines the heading level that splits into document segments. Valid values are h1, h2, h3, h4, h5, h6. The content // of the header field that the segmentation splits at is used as the **title** field for that segmented result. Only // valid if used with a collection that has **enabled** set to `false` in the **smart_document_understanding** object. SelectorTags []string `json:"selector_tags,omitempty"` // Defines the annotated smart document understanding fields that the document is split on. The content of the // annotated field that the segmentation splits at is used as the **title** field for that segmented result. For // example, if the field `sub-title` is specified, when a document is uploaded each time the smart documement // understanding conversion encounters a field of type `sub-title` the document is split at that point and the content // of the field used as the title of the remaining content. Thnis split is performed for all instances of the listed // fields in the uploaded document. Only valid if used with a collection that has **enabled** set to `true` in the // **smart_document_understanding** object. AnnotatedFields []string `json:"annotated_fields,omitempty"` }
SegmentSettings : A list of Document Segmentation settings.
type Source ¶
type Source struct { // The type of source to connect to. // - `box` indicates the configuration is to connect an instance of Enterprise Box. // - `salesforce` indicates the configuration is to connect to Salesforce. // - `sharepoint` indicates the configuration is to connect to Microsoft SharePoint Online. // - `web_crawl` indicates the configuration is to perform a web page crawl. // - `cloud_object_storage` indicates the configuration is to connect to a cloud object store. Type *string `json:"type,omitempty"` // The **credential_id** of the credentials to use to connect to the source. Credentials are defined using the // **credentials** method. The **source_type** of the credentials used must match the **type** field specified in this // object. CredentialID *string `json:"credential_id,omitempty"` // Object containing the schedule information for the source. Schedule *SourceSchedule `json:"schedule,omitempty"` // The **options** object defines which items to crawl from the source system. Options *SourceOptions `json:"options,omitempty"` }
Source : Object containing source parameters for the configuration.
type SourceOptions ¶
type SourceOptions struct { // Array of folders to crawl from the Box source. Only valid, and required, when the **type** field of the **source** // object is set to `box`. Folders []SourceOptionsFolder `json:"folders,omitempty"` // Array of Salesforce document object types to crawl from the Salesforce source. Only valid, and required, when the // **type** field of the **source** object is set to `salesforce`. Objects []SourceOptionsObject `json:"objects,omitempty"` // Array of Microsoft SharePointoint Online site collections to crawl from the SharePoint source. Only valid and // required when the **type** field of the **source** object is set to `sharepoint`. SiteCollections []SourceOptionsSiteColl `json:"site_collections,omitempty"` // Array of Web page URLs to begin crawling the web from. Only valid and required when the **type** field of the // **source** object is set to `web_crawl`. Urls []SourceOptionsWebCrawl `json:"urls,omitempty"` // Array of cloud object store buckets to begin crawling. Only valid and required when the **type** field of the // **source** object is set to `cloud_object_store`, and the **crawl_all_buckets** field is `false` or not specified. Buckets []SourceOptionsBuckets `json:"buckets,omitempty"` // When `true`, all buckets in the specified cloud object store are crawled. If set to `true`, the **buckets** array // must not be specified. CrawlAllBuckets *bool `json:"crawl_all_buckets,omitempty"` }
SourceOptions : The **options** object defines which items to crawl from the source system.
type SourceOptionsBuckets ¶
type SourceOptionsBuckets struct { // The name of the cloud object store bucket to crawl. Name *string `json:"name" validate:"required"` // The number of documents to crawl from this cloud object store bucket. If not specified, all documents in the bucket // are crawled. Limit *int64 `json:"limit,omitempty"` }
SourceOptionsBuckets : Object defining a cloud object store bucket to crawl.
type SourceOptionsFolder ¶
type SourceOptionsFolder struct { // The Box user ID of the user who owns the folder to crawl. OwnerUserID *string `json:"owner_user_id" validate:"required"` // The Box folder ID of the folder to crawl. FolderID *string `json:"folder_id" validate:"required"` // The maximum number of documents to crawl for this folder. By default, all documents in the folder are crawled. Limit *int64 `json:"limit,omitempty"` }
SourceOptionsFolder : Object that defines a box folder to crawl with this configuration.
type SourceOptionsObject ¶
type SourceOptionsObject struct { // The name of the Salesforce document object to crawl. For example, `case`. Name *string `json:"name" validate:"required"` // The maximum number of documents to crawl for this document object. By default, all documents in the document object // are crawled. Limit *int64 `json:"limit,omitempty"` }
SourceOptionsObject : Object that defines a Salesforce document object type crawl with this configuration.
type SourceOptionsSiteColl ¶
type SourceOptionsSiteColl struct { // The Microsoft SharePoint Online site collection path to crawl. The path must be be relative to the // **organization_url** that was specified in the credentials associated with this source configuration. SiteCollectionPath *string `json:"site_collection_path" validate:"required"` // The maximum number of documents to crawl for this site collection. By default, all documents in the site collection // are crawled. Limit *int64 `json:"limit,omitempty"` }
SourceOptionsSiteColl : Object that defines a Microsoft SharePoint site collection to crawl with this configuration.
type SourceOptionsWebCrawl ¶
type SourceOptionsWebCrawl struct { // The starting URL to crawl. URL *string `json:"url" validate:"required"` // When `true`, crawls of the specified URL are limited to the host part of the **url** field. LimitToStartingHosts *bool `json:"limit_to_starting_hosts,omitempty"` // The number of concurrent URLs to fetch. `gentle` means one URL is fetched at a time with a delay between each call. // `normal` means as many as two URLs are fectched concurrently with a short delay between fetch calls. `aggressive` // means that up to ten URLs are fetched concurrently with a short delay between fetch calls. CrawlSpeed *string `json:"crawl_speed,omitempty"` // When `true`, allows the crawl to interact with HTTPS sites with SSL certificates with untrusted signers. AllowUntrustedCertificate *bool `json:"allow_untrusted_certificate,omitempty"` // The maximum number of hops to make from the initial URL. When a page is crawled each link on that page will also be // crawled if it is within the **maximum_hops** from the initial URL. The first page crawled is 0 hops, each link // crawled from the first page is 1 hop, each link crawled from those pages is 2 hops, and so on. MaximumHops *int64 `json:"maximum_hops,omitempty"` // The maximum milliseconds to wait for a response from the web server. RequestTimeout *int64 `json:"request_timeout,omitempty"` // When `true`, the crawler will ignore any `robots.txt` encountered by the crawler. This should only ever be done when // crawling a web site the user owns. This must be be set to `true` when a **gateway_id** is specied in the // **credentials**. OverrideRobotsTxt *bool `json:"override_robots_txt,omitempty"` // Array of URL's to be excluded while crawling. The crawler will not follow links which contains this string. For // example, listing `https://ibm.com/watson` also excludes `https://ibm.com/watson/discovery`. Blacklist []string `json:"blacklist,omitempty"` }
SourceOptionsWebCrawl : Object defining which URL to crawl and how to crawl it.
type SourceSchedule ¶
type SourceSchedule struct { // When `true`, the source is re-crawled based on the **frequency** field in this object. When `false` the source is // not re-crawled; When `false` and connecting to Salesforce the source is crawled annually. Enabled *bool `json:"enabled,omitempty"` // The time zone to base source crawl times on. Possible values correspond to the IANA (Internet Assigned Numbers // Authority) time zones list. TimeZone *string `json:"time_zone,omitempty"` // The crawl schedule in the specified **time_zone**. // // - `five_minutes`: Runs every five minutes. // - `hourly`: Runs every hour. // - `daily`: Runs every day between 00:00 and 06:00. // - `weekly`: Runs every week on Sunday between 00:00 and 06:00. // - `monthly`: Runs the on the first Sunday of every month between 00:00 and 06:00. Frequency *string `json:"frequency,omitempty"` }
SourceSchedule : Object containing the schedule information for the source.
type SourceStatus ¶
type SourceStatus struct { // The current status of the source crawl for this collection. This field returns `not_configured` if the default // configuration for this source does not have a **source** object defined. // // - `running` indicates that a crawl to fetch more documents is in progress. // - `complete` indicates that the crawl has completed with no errors. // - `queued` indicates that the crawl has been paused by the system and will automatically restart when possible. // - `unknown` indicates that an unidentified error has occured in the service. Status *string `json:"status,omitempty"` // Date in `RFC 3339` format indicating the time of the next crawl attempt. NextCrawl *strfmt.DateTime `json:"next_crawl,omitempty"` }
SourceStatus : Object containing source crawl status information.
type StatusDetails ¶ added in v2.2.0
type StatusDetails struct { // Indicates whether the credential is accepted by the target data source. Authenticated *bool `json:"authenticated,omitempty"` // If `authenticated` is `false`, a message describes why the authentication was unsuccessful. ErrorMessage *string `json:"error_message,omitempty"` }
StatusDetails : Object that contains details about the status of the authentication process.
type Term ¶
type Term struct { // The type of aggregation command used. For example: term, filter, max, min, etc. Type *string `json:"type,omitempty"` // Array of aggregation results. Results []AggregationResult `json:"results,omitempty"` // Number of matching results. MatchingResults *int64 `json:"matching_results,omitempty"` // Aggregations returned by Discovery. Aggregations []QueryAggregationIntf `json:"aggregations,omitempty"` // The field where the aggregation is located in the document. Field *string `json:"field,omitempty"` // The number of terms identified. Count *int64 `json:"count,omitempty"` }
Term : Term struct This model "extends" QueryAggregation
type Timeslice ¶
type Timeslice struct { // The type of aggregation command used. For example: term, filter, max, min, etc. Type *string `json:"type,omitempty"` // Array of aggregation results. Results []AggregationResult `json:"results,omitempty"` // Number of matching results. MatchingResults *int64 `json:"matching_results,omitempty"` // Aggregations returned by Discovery. Aggregations []QueryAggregationIntf `json:"aggregations,omitempty"` // The field where the aggregation is located in the document. Field *string `json:"field,omitempty"` // Interval of the aggregation. Valid date interval values are second/seconds minute/minutes, hour/hours, day/days, // week/weeks, month/months, and year/years. Interval *string `json:"interval,omitempty"` // Used to indicate that anomaly detection should be performed. Anomaly detection is used to locate unusual datapoints // within a time series. Anomaly *bool `json:"anomaly,omitempty"` }
Timeslice : Timeslice struct This model "extends" QueryAggregation
type TokenDictRule ¶
type TokenDictRule struct { // The string to tokenize. Text *string `json:"text" validate:"required"` // Array of tokens that the `text` field is split into when found. Tokens []string `json:"tokens" validate:"required"` // Array of tokens that represent the content of the `text` field in an alternate character set. Readings []string `json:"readings,omitempty"` // The part of speech that the `text` string belongs to. For example `noun`. Custom parts of speech can be specified. PartOfSpeech *string `json:"part_of_speech" validate:"required"` }
TokenDictRule : An object defining a single tokenizaion rule.
type TokenDictStatusResponse ¶
type TokenDictStatusResponse struct { // Current wordlist status for the specified collection. Status *string `json:"status,omitempty"` // The type for this wordlist. Can be `tokenization_dictionary` or `stopwords`. Type *string `json:"type,omitempty"` }
TokenDictStatusResponse : Object describing the current status of the wordlist.
type TopHits ¶
type TopHits struct { // The type of aggregation command used. For example: term, filter, max, min, etc. Type *string `json:"type,omitempty"` // Array of aggregation results. Results []AggregationResult `json:"results,omitempty"` // Number of matching results. MatchingResults *int64 `json:"matching_results,omitempty"` // Aggregations returned by Discovery. Aggregations []QueryAggregationIntf `json:"aggregations,omitempty"` // Number of top hits returned by the aggregation. Size *int64 `json:"size,omitempty"` Hits *TopHitsResults `json:"hits,omitempty"` }
TopHits : TopHits struct This model "extends" QueryAggregation
type TopHitsResults ¶
type TopHitsResults struct { // Number of matching results. MatchingResults *int64 `json:"matching_results,omitempty"` // Top results returned by the aggregation. Hits []QueryResult `json:"hits,omitempty"` }
TopHitsResults : Top hit information for this query.
type TrainingDataSet ¶
type TrainingDataSet struct { // The environment id associated with this training data set. EnvironmentID *string `json:"environment_id,omitempty"` // The collection id associated with this training data set. CollectionID *string `json:"collection_id,omitempty"` // Array of training queries. Queries []TrainingQuery `json:"queries,omitempty"` }
TrainingDataSet : Training information for a specific collection.
type TrainingExample ¶
type TrainingExample struct { // The document ID associated with this training example. DocumentID *string `json:"document_id,omitempty"` // The cross reference associated with this training example. CrossReference *string `json:"cross_reference,omitempty"` // The relevance of the training example. Relevance *int64 `json:"relevance,omitempty"` }
TrainingExample : Training example details.
type TrainingExampleList ¶
type TrainingExampleList struct { // Array of training examples. Examples []TrainingExample `json:"examples,omitempty"` }
TrainingExampleList : Object containing an array of training examples.
type TrainingQuery ¶
type TrainingQuery struct { // The query ID associated with the training query. QueryID *string `json:"query_id,omitempty"` // The natural text query for the training query. NaturalLanguageQuery *string `json:"natural_language_query,omitempty"` // The filter used on the collection before the **natural_language_query** is applied. Filter *string `json:"filter,omitempty"` // Array of training examples. Examples []TrainingExample `json:"examples,omitempty"` }
TrainingQuery : Training query details.
type TrainingStatus ¶
type TrainingStatus struct { // The total number of training examples uploaded to this collection. TotalExamples *int64 `json:"total_examples,omitempty"` // When `true`, the collection has been successfully trained. Available *bool `json:"available,omitempty"` // When `true`, the collection is currently processing training. Processing *bool `json:"processing,omitempty"` // When `true`, the collection has a sufficent amount of queries added for training to occur. MinimumQueriesAdded *bool `json:"minimum_queries_added,omitempty"` // When `true`, the collection has a sufficent amount of examples added for training to occur. MinimumExamplesAdded *bool `json:"minimum_examples_added,omitempty"` // When `true`, the collection has a sufficent amount of diversity in labeled results for training to occur. SufficientLabelDiversity *bool `json:"sufficient_label_diversity,omitempty"` // The number of notices associated with this data set. Notices *int64 `json:"notices,omitempty"` // The timestamp of when the collection was successfully trained. SuccessfullyTrained *strfmt.DateTime `json:"successfully_trained,omitempty"` // The timestamp of when the data was uploaded. DataUpdated *strfmt.DateTime `json:"data_updated,omitempty"` }
TrainingStatus : Training status details.
type UpdateCollectionOptions ¶
type UpdateCollectionOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // The name of the collection. Name *string `json:"name" validate:"required"` // A description of the collection. Description *string `json:"description,omitempty"` // The ID of the configuration in which the collection is to be updated. ConfigurationID *string `json:"configuration_id,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
UpdateCollectionOptions : The UpdateCollection options.
func (*UpdateCollectionOptions) SetCollectionID ¶
func (_options *UpdateCollectionOptions) SetCollectionID(collectionID string) *UpdateCollectionOptions
SetCollectionID : Allow user to set CollectionID
func (*UpdateCollectionOptions) SetConfigurationID ¶
func (_options *UpdateCollectionOptions) SetConfigurationID(configurationID string) *UpdateCollectionOptions
SetConfigurationID : Allow user to set ConfigurationID
func (*UpdateCollectionOptions) SetDescription ¶
func (_options *UpdateCollectionOptions) SetDescription(description string) *UpdateCollectionOptions
SetDescription : Allow user to set Description
func (*UpdateCollectionOptions) SetEnvironmentID ¶
func (_options *UpdateCollectionOptions) SetEnvironmentID(environmentID string) *UpdateCollectionOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*UpdateCollectionOptions) SetHeaders ¶
func (options *UpdateCollectionOptions) SetHeaders(param map[string]string) *UpdateCollectionOptions
SetHeaders : Allow user to set Headers
func (*UpdateCollectionOptions) SetName ¶
func (_options *UpdateCollectionOptions) SetName(name string) *UpdateCollectionOptions
SetName : Allow user to set Name
type UpdateConfigurationOptions ¶
type UpdateConfigurationOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the configuration. ConfigurationID *string `json:"-" validate:"required,ne="` // The name of the configuration. Name *string `json:"name" validate:"required"` // The description of the configuration, if available. Description *string `json:"description,omitempty"` // Document conversion settings. Conversions *Conversions `json:"conversions,omitempty"` // An array of document enrichment settings for the configuration. Enrichments []Enrichment `json:"enrichments,omitempty"` // Defines operations that can be used to transform the final output JSON into a normalized form. Operations are // executed in the order that they appear in the array. Normalizations []NormalizationOperation `json:"normalizations,omitempty"` // Object containing source parameters for the configuration. Source *Source `json:"source,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
UpdateConfigurationOptions : The UpdateConfiguration options.
func (*UpdateConfigurationOptions) SetConfigurationID ¶
func (_options *UpdateConfigurationOptions) SetConfigurationID(configurationID string) *UpdateConfigurationOptions
SetConfigurationID : Allow user to set ConfigurationID
func (*UpdateConfigurationOptions) SetConversions ¶
func (_options *UpdateConfigurationOptions) SetConversions(conversions *Conversions) *UpdateConfigurationOptions
SetConversions : Allow user to set Conversions
func (*UpdateConfigurationOptions) SetDescription ¶
func (_options *UpdateConfigurationOptions) SetDescription(description string) *UpdateConfigurationOptions
SetDescription : Allow user to set Description
func (*UpdateConfigurationOptions) SetEnrichments ¶
func (_options *UpdateConfigurationOptions) SetEnrichments(enrichments []Enrichment) *UpdateConfigurationOptions
SetEnrichments : Allow user to set Enrichments
func (*UpdateConfigurationOptions) SetEnvironmentID ¶
func (_options *UpdateConfigurationOptions) SetEnvironmentID(environmentID string) *UpdateConfigurationOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*UpdateConfigurationOptions) SetHeaders ¶
func (options *UpdateConfigurationOptions) SetHeaders(param map[string]string) *UpdateConfigurationOptions
SetHeaders : Allow user to set Headers
func (*UpdateConfigurationOptions) SetName ¶
func (_options *UpdateConfigurationOptions) SetName(name string) *UpdateConfigurationOptions
SetName : Allow user to set Name
func (*UpdateConfigurationOptions) SetNormalizations ¶
func (_options *UpdateConfigurationOptions) SetNormalizations(normalizations []NormalizationOperation) *UpdateConfigurationOptions
SetNormalizations : Allow user to set Normalizations
func (*UpdateConfigurationOptions) SetSource ¶
func (_options *UpdateConfigurationOptions) SetSource(source *Source) *UpdateConfigurationOptions
SetSource : Allow user to set Source
type UpdateCredentialsOptions ¶
type UpdateCredentialsOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The unique identifier for a set of source credentials. CredentialID *string `json:"-" validate:"required,ne="` // The source that this credentials object connects to. // - `box` indicates the credentials are used to connect an instance of Enterprise Box. // - `salesforce` indicates the credentials are used to connect to Salesforce. // - `sharepoint` indicates the credentials are used to connect to Microsoft SharePoint Online. // - `web_crawl` indicates the credentials are used to perform a web crawl. // = `cloud_object_storage` indicates the credentials are used to connect to an IBM Cloud Object Store. SourceType *string `json:"source_type,omitempty"` // Object containing details of the stored credentials. // // Obtain credentials for your source from the administrator of the source. CredentialDetails *CredentialDetails `json:"credential_details,omitempty"` // Object that contains details about the status of the authentication process. Status *StatusDetails `json:"status,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
UpdateCredentialsOptions : The UpdateCredentials options.
func (*UpdateCredentialsOptions) SetCredentialDetails ¶
func (_options *UpdateCredentialsOptions) SetCredentialDetails(credentialDetails *CredentialDetails) *UpdateCredentialsOptions
SetCredentialDetails : Allow user to set CredentialDetails
func (*UpdateCredentialsOptions) SetCredentialID ¶
func (_options *UpdateCredentialsOptions) SetCredentialID(credentialID string) *UpdateCredentialsOptions
SetCredentialID : Allow user to set CredentialID
func (*UpdateCredentialsOptions) SetEnvironmentID ¶
func (_options *UpdateCredentialsOptions) SetEnvironmentID(environmentID string) *UpdateCredentialsOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*UpdateCredentialsOptions) SetHeaders ¶
func (options *UpdateCredentialsOptions) SetHeaders(param map[string]string) *UpdateCredentialsOptions
SetHeaders : Allow user to set Headers
func (*UpdateCredentialsOptions) SetSourceType ¶
func (_options *UpdateCredentialsOptions) SetSourceType(sourceType string) *UpdateCredentialsOptions
SetSourceType : Allow user to set SourceType
func (*UpdateCredentialsOptions) SetStatus ¶
func (_options *UpdateCredentialsOptions) SetStatus(status *StatusDetails) *UpdateCredentialsOptions
SetStatus : Allow user to set Status
type UpdateDocumentOptions ¶
type UpdateDocumentOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // The ID of the document. DocumentID *string `json:"-" validate:"required,ne="` // The content of the document to ingest. The maximum supported file size when adding a file to a collection is 50 // megabytes, the maximum supported file size when testing a configuration is 1 megabyte. Files larger than the // supported size are rejected. File io.ReadCloser `json:"-"` // The filename for file. Filename *string `json:"-"` // The content type of file. FileContentType *string `json:"-"` // The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: “` { // "Creator": "Johnny Appleseed", // "Subject": "Apples" // } “`. Metadata *string `json:"-"` // Allows users to set headers on API requests Headers map[string]string }
UpdateDocumentOptions : The UpdateDocument options.
func (*UpdateDocumentOptions) SetCollectionID ¶
func (_options *UpdateDocumentOptions) SetCollectionID(collectionID string) *UpdateDocumentOptions
SetCollectionID : Allow user to set CollectionID
func (*UpdateDocumentOptions) SetDocumentID ¶
func (_options *UpdateDocumentOptions) SetDocumentID(documentID string) *UpdateDocumentOptions
SetDocumentID : Allow user to set DocumentID
func (*UpdateDocumentOptions) SetEnvironmentID ¶
func (_options *UpdateDocumentOptions) SetEnvironmentID(environmentID string) *UpdateDocumentOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*UpdateDocumentOptions) SetFile ¶
func (_options *UpdateDocumentOptions) SetFile(file io.ReadCloser) *UpdateDocumentOptions
SetFile : Allow user to set File
func (*UpdateDocumentOptions) SetFileContentType ¶
func (_options *UpdateDocumentOptions) SetFileContentType(fileContentType string) *UpdateDocumentOptions
SetFileContentType : Allow user to set FileContentType
func (*UpdateDocumentOptions) SetFilename ¶
func (_options *UpdateDocumentOptions) SetFilename(filename string) *UpdateDocumentOptions
SetFilename : Allow user to set Filename
func (*UpdateDocumentOptions) SetHeaders ¶
func (options *UpdateDocumentOptions) SetHeaders(param map[string]string) *UpdateDocumentOptions
SetHeaders : Allow user to set Headers
func (*UpdateDocumentOptions) SetMetadata ¶
func (_options *UpdateDocumentOptions) SetMetadata(metadata string) *UpdateDocumentOptions
SetMetadata : Allow user to set Metadata
type UpdateEnvironmentOptions ¶
type UpdateEnvironmentOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // Name that identifies the environment. Name *string `json:"name,omitempty"` // Description of the environment. Description *string `json:"description,omitempty"` // Size that the environment should be increased to. Environment size cannot be modified when using a Lite plan. // Environment size can only increased and not decreased. Size *string `json:"size,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
UpdateEnvironmentOptions : The UpdateEnvironment options.
func (*UpdateEnvironmentOptions) SetDescription ¶
func (_options *UpdateEnvironmentOptions) SetDescription(description string) *UpdateEnvironmentOptions
SetDescription : Allow user to set Description
func (*UpdateEnvironmentOptions) SetEnvironmentID ¶
func (_options *UpdateEnvironmentOptions) SetEnvironmentID(environmentID string) *UpdateEnvironmentOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*UpdateEnvironmentOptions) SetHeaders ¶
func (options *UpdateEnvironmentOptions) SetHeaders(param map[string]string) *UpdateEnvironmentOptions
SetHeaders : Allow user to set Headers
func (*UpdateEnvironmentOptions) SetName ¶
func (_options *UpdateEnvironmentOptions) SetName(name string) *UpdateEnvironmentOptions
SetName : Allow user to set Name
func (*UpdateEnvironmentOptions) SetSize ¶
func (_options *UpdateEnvironmentOptions) SetSize(size string) *UpdateEnvironmentOptions
SetSize : Allow user to set Size
type UpdateTrainingExampleOptions ¶
type UpdateTrainingExampleOptions struct { // The ID of the environment. EnvironmentID *string `json:"-" validate:"required,ne="` // The ID of the collection. CollectionID *string `json:"-" validate:"required,ne="` // The ID of the query used for training. QueryID *string `json:"-" validate:"required,ne="` // The ID of the document as it is indexed. ExampleID *string `json:"-" validate:"required,ne="` // The example to add. CrossReference *string `json:"cross_reference,omitempty"` // The relevance value for this example. Relevance *int64 `json:"relevance,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
UpdateTrainingExampleOptions : The UpdateTrainingExample options.
func (*UpdateTrainingExampleOptions) SetCollectionID ¶
func (_options *UpdateTrainingExampleOptions) SetCollectionID(collectionID string) *UpdateTrainingExampleOptions
SetCollectionID : Allow user to set CollectionID
func (*UpdateTrainingExampleOptions) SetCrossReference ¶
func (_options *UpdateTrainingExampleOptions) SetCrossReference(crossReference string) *UpdateTrainingExampleOptions
SetCrossReference : Allow user to set CrossReference
func (*UpdateTrainingExampleOptions) SetEnvironmentID ¶
func (_options *UpdateTrainingExampleOptions) SetEnvironmentID(environmentID string) *UpdateTrainingExampleOptions
SetEnvironmentID : Allow user to set EnvironmentID
func (*UpdateTrainingExampleOptions) SetExampleID ¶
func (_options *UpdateTrainingExampleOptions) SetExampleID(exampleID string) *UpdateTrainingExampleOptions
SetExampleID : Allow user to set ExampleID
func (*UpdateTrainingExampleOptions) SetHeaders ¶
func (options *UpdateTrainingExampleOptions) SetHeaders(param map[string]string) *UpdateTrainingExampleOptions
SetHeaders : Allow user to set Headers
func (*UpdateTrainingExampleOptions) SetQueryID ¶
func (_options *UpdateTrainingExampleOptions) SetQueryID(queryID string) *UpdateTrainingExampleOptions
SetQueryID : Allow user to set QueryID
func (*UpdateTrainingExampleOptions) SetRelevance ¶
func (_options *UpdateTrainingExampleOptions) SetRelevance(relevance int64) *UpdateTrainingExampleOptions
SetRelevance : Allow user to set Relevance
type WordHeadingDetection ¶
type WordHeadingDetection struct { // Array of font matching configurations. Fonts []FontSetting `json:"fonts,omitempty"` // Array of Microsoft Word styles to convert. Styles []WordStyle `json:"styles,omitempty"` }
WordHeadingDetection : Object containing heading detection conversion settings for Microsoft Word documents.
type WordSettings ¶
type WordSettings struct { // Object containing heading detection conversion settings for Microsoft Word documents. Heading *WordHeadingDetection `json:"heading,omitempty"` }
WordSettings : A list of Word conversion settings.
type WordStyle ¶
type WordStyle struct { // HTML head level that content matching this style is tagged with. Level *int64 `json:"level,omitempty"` // Array of word style names to convert. Names []string `json:"names,omitempty"` }
WordStyle : Microsoft Word styles to convert into a specified HTML head level.
type XPathPatterns ¶
type XPathPatterns struct { // An array to XPaths. Xpaths []string `json:"xpaths,omitempty"` }
XPathPatterns : Object containing an array of XPaths.